# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# NOTE: This file is auto generated by the elixir code generator program.
# Do not edit this file manually.
defmodule GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProduct do
@moduledoc """
## Attributes
* `apiResources` (*type:* `list(String.t)`, *default:* `nil`) -
* `approvalType` (*type:* `String.t`, *default:* `nil`) - Flag that specifies how API keys are approved to access the APIs defined by the API product. If set to `manual`, the consumer key is generated and returned in "pending" state. In this case, the API keys won't work until they have been explicitly approved. If set to `auto`, the consumer key is generated and returned in "approved" state and can be used immediately. **Note:** Typically, `auto` is used to provide access to free or trial API products that provide limited quota or capabilities.
* `attributes` (*type:* `list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t)`, *default:* `nil`) - Array of attributes that may be used to extend the default API product profile with customer-specific metadata. You can specify a maximum of 18 attributes. Use this property to specify the access level of the API product as either `public`, `private`, or `internal`. Only products marked `public` are available to developers in the Apigee developer portal. For example, you can set a product to `internal` while it is in development and then change access to `public` when it is ready to release on the portal. API products marked as `private` do not appear on the portal, but can be accessed by external developers.
* `createdAt` (*type:* `String.t`, *default:* `nil`) - Response only. Creation time of this environment as milliseconds since epoch.
* `description` (*type:* `String.t`, *default:* `nil`) - Description of the API product. Include key information about the API product that is not captured by other fields. Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - `/**`: Indicates that all sub-URIs are included. - `/*` : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see Managing API products.
* `displayName` (*type:* `String.t`, *default:* `nil`) - Name displayed in the UI or developer portal to developers registering for API access.
* `environments` (*type:* `list(String.t)`, *default:* `nil`) - Comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in `prod` from being accessed by API proxies deployed in `test`.
* `graphqlOperationGroup` (*type:* `GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1GraphQLOperationGroup.t`, *default:* `nil`) - Configuration used to group Apigee proxies or remote services with graphQL operation name, graphQL operation type and quotas. This grouping allows us to precisely set quota for a particular combination of graphQL name and operation type for a particular proxy request. If graphQL name is not set, this would imply quota will be applied on all graphQL requests matching the operation type.
* `lastModifiedAt` (*type:* `String.t`, *default:* `nil`) - Response only. Modified time of this environment as milliseconds since epoch.
* `name` (*type:* `String.t`, *default:* `nil`) - Internal name of the API product. Characters you can use in the name are restricted to: `A-Z0-9._\\-$ %`. **Note:** The internal name cannot be edited when updating the API product.
* `operationGroup` (*type:* `GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1OperationGroup.t`, *default:* `nil`) - Configuration used to group Apigee proxies or remote services with resources, method types, and quotas. The resource refers to the resource URI (excluding the base path). With this grouping, the API product creator is able to fine-tune and give precise control over which REST methods have access to specific resources and how many calls can be made (using the `quota` setting). **Note:** The `api_resources` setting cannot be specified for both the API product and operation group; otherwise the call will fail.
* `proxies` (*type:* `list(String.t)`, *default:* `nil`) - Comma-separated list of API proxy names to which this API product is bound. By specifying API proxies, you can associate resources in the API product with specific API proxies, preventing developers from accessing those resources through other API proxies. Apigee rejects requests to API proxies that are not listed. **Note:** The API proxy names must already exist in the specified environment as they will be validated upon creation.
* `quota` (*type:* `String.t`, *default:* `nil`) - Number of request messages permitted per app by this API product for the specified `quotaInterval` and `quotaTimeUnit`. For example, a `quota` of 50, for a `quotaInterval` of 12 and a `quotaTimeUnit` of hours means 50 requests are allowed every 12 hours.
* `quotaInterval` (*type:* `String.t`, *default:* `nil`) - Time interval over which the number of request messages is calculated.
* `quotaTimeUnit` (*type:* `String.t`, *default:* `nil`) - Time unit defined for the `quotaInterval`. Valid values include `minute`, `hour`, `day`, or `month`.
* `scopes` (*type:* `list(String.t)`, *default:* `nil`) - Comma-separated list of OAuth scopes that are validated at runtime. Apigee validates that the scopes in any access token presented match the scopes defined in the OAuth policy associated with the API product.
"""
use GoogleApi.Gax.ModelBase
@type t :: %__MODULE__{
:apiResources => list(String.t()) | nil,
:approvalType => String.t() | nil,
:attributes => list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t()) | nil,
:createdAt => String.t() | nil,
:description => String.t() | nil,
:displayName => String.t() | nil,
:environments => list(String.t()) | nil,
:graphqlOperationGroup =>
GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1GraphQLOperationGroup.t() | nil,
:lastModifiedAt => String.t() | nil,
:name => String.t() | nil,
:operationGroup =>
GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1OperationGroup.t() | nil,
:proxies => list(String.t()) | nil,
:quota => String.t() | nil,
:quotaInterval => String.t() | nil,
:quotaTimeUnit => String.t() | nil,
:scopes => list(String.t()) | nil
}
field(:apiResources, type: :list)
field(:approvalType)
field(:attributes, as: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute, type: :list)
field(:createdAt)
field(:description)
field(:displayName)
field(:environments, type: :list)
field(:graphqlOperationGroup,
as: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1GraphQLOperationGroup
)
field(:lastModifiedAt)
field(:name)
field(:operationGroup, as: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1OperationGroup)
field(:proxies, type: :list)
field(:quota)
field(:quotaInterval)
field(:quotaTimeUnit)
field(:scopes, type: :list)
end
defimpl Poison.Decoder, for: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProduct do
def decode(value, options) do
GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProduct.decode(value, options)
end
end
defimpl Poison.Encoder, for: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProduct do
def encode(value, options) do
GoogleApi.Gax.ModelBase.encode(value, options)
end
end
