Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.apigee/v1.getApiProduct
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Gets configuration details for an API product. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via the UI or the API. View the list of API products to verify the internal name.
Using getApiProduct
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getApiProduct(args: GetApiProductArgs, opts?: InvokeOptions): Promise<GetApiProductResult>
function getApiProductOutput(args: GetApiProductOutputArgs, opts?: InvokeOptions): Output<GetApiProductResult>def get_api_product(apiproduct_id: Optional[str] = None,
                    organization_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetApiProductResult
def get_api_product_output(apiproduct_id: Optional[pulumi.Input[str]] = None,
                    organization_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetApiProductResult]func LookupApiProduct(ctx *Context, args *LookupApiProductArgs, opts ...InvokeOption) (*LookupApiProductResult, error)
func LookupApiProductOutput(ctx *Context, args *LookupApiProductOutputArgs, opts ...InvokeOption) LookupApiProductResultOutput> Note: This function is named LookupApiProduct in the Go SDK.
public static class GetApiProduct 
{
    public static Task<GetApiProductResult> InvokeAsync(GetApiProductArgs args, InvokeOptions? opts = null)
    public static Output<GetApiProductResult> Invoke(GetApiProductInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetApiProductResult> getApiProduct(GetApiProductArgs args, InvokeOptions options)
public static Output<GetApiProductResult> getApiProduct(GetApiProductArgs args, InvokeOptions options)
fn::invoke:
  function: google-native:apigee/v1:getApiProduct
  arguments:
    # arguments dictionaryThe following arguments are supported:
- ApiproductId string
- OrganizationId string
- ApiproductId string
- OrganizationId string
- apiproductId String
- organizationId String
- apiproductId string
- organizationId string
- apiproduct_id str
- organization_id str
- apiproductId String
- organizationId String
getApiProduct Result
The following output properties are available:
- ApiResources List<string>
- Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the proxy.pathsuffixvariable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if theapiResourceselement is defined to be/forecastrssand the base path defined for the API proxy is/weather, then only requests to/weather/forecastrssare 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/weatherapikeyand to any sub-URIs, such as/v1/weatherapikey/forecastrss,/v1/weatherapikey/region/CA, and so on. For more information, see Managing API products.
- ApprovalType string
- 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 toauto, the consumer key is generated and returned in "approved" state and can be used immediately. Note: Typically,autois used to provide access to free or trial API products that provide limited quota or capabilities.
- Attributes
List<Pulumi.Google Native. Apigee. V1. Outputs. Google Cloud Apigee V1Attribute Response> 
- 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, orinternal. Only products markedpublicare available to developers in the Apigee developer portal. For example, you can set a product tointernalwhile it is in development and then change access topublicwhen it is ready to release on the portal. API products marked asprivatedo not appear on the portal, but can be accessed by external developers.
- CreatedAt string
- Response only. Creation time of this environment as milliseconds since epoch.
- Description string
- Description of the API product. Include key information about the API product that is not captured by other fields.
- DisplayName string
- Name displayed in the UI or developer portal to developers registering for API access.
- Environments List<string>
- 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 prodfrom being accessed by API proxies deployed intest.
- GraphqlOperation Pulumi.Group Google Native. Apigee. V1. Outputs. Google Cloud Apigee V1Graph QLOperation Group Response 
- 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.
- GrpcOperation Pulumi.Group Google Native. Apigee. V1. Outputs. Google Cloud Apigee V1Grpc Operation Group Response 
- Optional. Configuration used to group Apigee proxies with gRPC services and method names. This grouping allows us to set quota for a particular proxy with the gRPC service name and method. If a method name is not set, this implies quota and authorization are applied to all gRPC methods implemented by that proxy for that particular gRPC service.
- LastModified stringAt 
- Response only. Modified time of this environment as milliseconds since epoch.
- Name string
- 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 Pulumi.Google Native. Apigee. V1. Outputs. Google Cloud Apigee V1Operation Group Response 
- 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 quotasetting). Note: Theapi_resourcessetting cannot be specified for both the API product and operation group; otherwise the call will fail.
- Proxies List<string>
- 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 string
- Number of request messages permitted per app by this API product for the specified quotaIntervalandquotaTimeUnit. For example, aquotaof 50, for aquotaIntervalof 12 and aquotaTimeUnitof hours means 50 requests are allowed every 12 hours.
- QuotaCounter stringScope 
- Scope of the quota decides how the quota counter gets applied and evaluate for quota violation. If the Scope is set as PROXY, then all the operations defined for the APIproduct that are associated with the same proxy will share the same quota counter set at the APIproduct level, making it a global counter at a proxy level. If the Scope is set as OPERATION, then each operations get the counter set at the API product dedicated, making it a local counter. Note that, the QuotaCounterScope applies only when an operation does not have dedicated quota set for itself.
- QuotaInterval string
- Time interval over which the number of request messages is calculated.
- QuotaTime stringUnit 
- Time unit defined for the quotaInterval. Valid values includeminute,hour,day, ormonth.
- Scopes List<string>
- 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.
- ApiResources []string
- Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the proxy.pathsuffixvariable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if theapiResourceselement is defined to be/forecastrssand the base path defined for the API proxy is/weather, then only requests to/weather/forecastrssare 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/weatherapikeyand to any sub-URIs, such as/v1/weatherapikey/forecastrss,/v1/weatherapikey/region/CA, and so on. For more information, see Managing API products.
- ApprovalType string
- 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 toauto, the consumer key is generated and returned in "approved" state and can be used immediately. Note: Typically,autois used to provide access to free or trial API products that provide limited quota or capabilities.
- Attributes
[]GoogleCloud Apigee V1Attribute Response 
- 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, orinternal. Only products markedpublicare available to developers in the Apigee developer portal. For example, you can set a product tointernalwhile it is in development and then change access topublicwhen it is ready to release on the portal. API products marked asprivatedo not appear on the portal, but can be accessed by external developers.
- CreatedAt string
- Response only. Creation time of this environment as milliseconds since epoch.
- Description string
- Description of the API product. Include key information about the API product that is not captured by other fields.
- DisplayName string
- Name displayed in the UI or developer portal to developers registering for API access.
- Environments []string
- 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 prodfrom being accessed by API proxies deployed intest.
- GraphqlOperation GoogleGroup Cloud Apigee V1Graph QLOperation Group Response 
- 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.
- GrpcOperation GoogleGroup Cloud Apigee V1Grpc Operation Group Response 
- Optional. Configuration used to group Apigee proxies with gRPC services and method names. This grouping allows us to set quota for a particular proxy with the gRPC service name and method. If a method name is not set, this implies quota and authorization are applied to all gRPC methods implemented by that proxy for that particular gRPC service.
- LastModified stringAt 
- Response only. Modified time of this environment as milliseconds since epoch.
- Name string
- 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 GoogleCloud Apigee V1Operation Group Response 
- 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 quotasetting). Note: Theapi_resourcessetting cannot be specified for both the API product and operation group; otherwise the call will fail.
- Proxies []string
- 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 string
- Number of request messages permitted per app by this API product for the specified quotaIntervalandquotaTimeUnit. For example, aquotaof 50, for aquotaIntervalof 12 and aquotaTimeUnitof hours means 50 requests are allowed every 12 hours.
- QuotaCounter stringScope 
- Scope of the quota decides how the quota counter gets applied and evaluate for quota violation. If the Scope is set as PROXY, then all the operations defined for the APIproduct that are associated with the same proxy will share the same quota counter set at the APIproduct level, making it a global counter at a proxy level. If the Scope is set as OPERATION, then each operations get the counter set at the API product dedicated, making it a local counter. Note that, the QuotaCounterScope applies only when an operation does not have dedicated quota set for itself.
- QuotaInterval string
- Time interval over which the number of request messages is calculated.
- QuotaTime stringUnit 
- Time unit defined for the quotaInterval. Valid values includeminute,hour,day, ormonth.
- Scopes []string
- 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.
- apiResources List<String>
- Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the proxy.pathsuffixvariable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if theapiResourceselement is defined to be/forecastrssand the base path defined for the API proxy is/weather, then only requests to/weather/forecastrssare 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/weatherapikeyand to any sub-URIs, such as/v1/weatherapikey/forecastrss,/v1/weatherapikey/region/CA, and so on. For more information, see Managing API products.
- approvalType String
- 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 toauto, the consumer key is generated and returned in "approved" state and can be used immediately. Note: Typically,autois used to provide access to free or trial API products that provide limited quota or capabilities.
- attributes
List<GoogleCloud Apigee V1Attribute Response> 
- 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, orinternal. Only products markedpublicare available to developers in the Apigee developer portal. For example, you can set a product tointernalwhile it is in development and then change access topublicwhen it is ready to release on the portal. API products marked asprivatedo not appear on the portal, but can be accessed by external developers.
- createdAt String
- Response only. Creation time of this environment as milliseconds since epoch.
- description String
- Description of the API product. Include key information about the API product that is not captured by other fields.
- displayName String
- Name displayed in the UI or developer portal to developers registering for API access.
- environments List<String>
- 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 prodfrom being accessed by API proxies deployed intest.
- graphqlOperation GoogleGroup Cloud Apigee V1Graph QLOperation Group Response 
- 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.
- grpcOperation GoogleGroup Cloud Apigee V1Grpc Operation Group Response 
- Optional. Configuration used to group Apigee proxies with gRPC services and method names. This grouping allows us to set quota for a particular proxy with the gRPC service name and method. If a method name is not set, this implies quota and authorization are applied to all gRPC methods implemented by that proxy for that particular gRPC service.
- lastModified StringAt 
- Response only. Modified time of this environment as milliseconds since epoch.
- name String
- 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 GoogleCloud Apigee V1Operation Group Response 
- 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 quotasetting). Note: Theapi_resourcessetting cannot be specified for both the API product and operation group; otherwise the call will fail.
- proxies List<String>
- 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 String
- Number of request messages permitted per app by this API product for the specified quotaIntervalandquotaTimeUnit. For example, aquotaof 50, for aquotaIntervalof 12 and aquotaTimeUnitof hours means 50 requests are allowed every 12 hours.
- quotaCounter StringScope 
- Scope of the quota decides how the quota counter gets applied and evaluate for quota violation. If the Scope is set as PROXY, then all the operations defined for the APIproduct that are associated with the same proxy will share the same quota counter set at the APIproduct level, making it a global counter at a proxy level. If the Scope is set as OPERATION, then each operations get the counter set at the API product dedicated, making it a local counter. Note that, the QuotaCounterScope applies only when an operation does not have dedicated quota set for itself.
- quotaInterval String
- Time interval over which the number of request messages is calculated.
- quotaTime StringUnit 
- Time unit defined for the quotaInterval. Valid values includeminute,hour,day, ormonth.
- scopes List<String>
- 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.
- apiResources string[]
- Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the proxy.pathsuffixvariable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if theapiResourceselement is defined to be/forecastrssand the base path defined for the API proxy is/weather, then only requests to/weather/forecastrssare 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/weatherapikeyand to any sub-URIs, such as/v1/weatherapikey/forecastrss,/v1/weatherapikey/region/CA, and so on. For more information, see Managing API products.
- approvalType string
- 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 toauto, the consumer key is generated and returned in "approved" state and can be used immediately. Note: Typically,autois used to provide access to free or trial API products that provide limited quota or capabilities.
- attributes
GoogleCloud Apigee V1Attribute Response[] 
- 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, orinternal. Only products markedpublicare available to developers in the Apigee developer portal. For example, you can set a product tointernalwhile it is in development and then change access topublicwhen it is ready to release on the portal. API products marked asprivatedo not appear on the portal, but can be accessed by external developers.
- createdAt string
- Response only. Creation time of this environment as milliseconds since epoch.
- description string
- Description of the API product. Include key information about the API product that is not captured by other fields.
- displayName string
- Name displayed in the UI or developer portal to developers registering for API access.
- environments string[]
- 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 prodfrom being accessed by API proxies deployed intest.
- graphqlOperation GoogleGroup Cloud Apigee V1Graph QLOperation Group Response 
- 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.
- grpcOperation GoogleGroup Cloud Apigee V1Grpc Operation Group Response 
- Optional. Configuration used to group Apigee proxies with gRPC services and method names. This grouping allows us to set quota for a particular proxy with the gRPC service name and method. If a method name is not set, this implies quota and authorization are applied to all gRPC methods implemented by that proxy for that particular gRPC service.
- lastModified stringAt 
- Response only. Modified time of this environment as milliseconds since epoch.
- name string
- 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 GoogleCloud Apigee V1Operation Group Response 
- 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 quotasetting). Note: Theapi_resourcessetting cannot be specified for both the API product and operation group; otherwise the call will fail.
- proxies string[]
- 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 string
- Number of request messages permitted per app by this API product for the specified quotaIntervalandquotaTimeUnit. For example, aquotaof 50, for aquotaIntervalof 12 and aquotaTimeUnitof hours means 50 requests are allowed every 12 hours.
- quotaCounter stringScope 
- Scope of the quota decides how the quota counter gets applied and evaluate for quota violation. If the Scope is set as PROXY, then all the operations defined for the APIproduct that are associated with the same proxy will share the same quota counter set at the APIproduct level, making it a global counter at a proxy level. If the Scope is set as OPERATION, then each operations get the counter set at the API product dedicated, making it a local counter. Note that, the QuotaCounterScope applies only when an operation does not have dedicated quota set for itself.
- quotaInterval string
- Time interval over which the number of request messages is calculated.
- quotaTime stringUnit 
- Time unit defined for the quotaInterval. Valid values includeminute,hour,day, ormonth.
- scopes string[]
- 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.
- api_resources Sequence[str]
- Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the proxy.pathsuffixvariable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if theapiResourceselement is defined to be/forecastrssand the base path defined for the API proxy is/weather, then only requests to/weather/forecastrssare 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/weatherapikeyand to any sub-URIs, such as/v1/weatherapikey/forecastrss,/v1/weatherapikey/region/CA, and so on. For more information, see Managing API products.
- approval_type str
- 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 toauto, the consumer key is generated and returned in "approved" state and can be used immediately. Note: Typically,autois used to provide access to free or trial API products that provide limited quota or capabilities.
- attributes
Sequence[GoogleCloud Apigee V1Attribute Response] 
- 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, orinternal. Only products markedpublicare available to developers in the Apigee developer portal. For example, you can set a product tointernalwhile it is in development and then change access topublicwhen it is ready to release on the portal. API products marked asprivatedo not appear on the portal, but can be accessed by external developers.
- created_at str
- Response only. Creation time of this environment as milliseconds since epoch.
- description str
- Description of the API product. Include key information about the API product that is not captured by other fields.
- display_name str
- Name displayed in the UI or developer portal to developers registering for API access.
- environments Sequence[str]
- 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 prodfrom being accessed by API proxies deployed intest.
- graphql_operation_ Googlegroup Cloud Apigee V1Graph QLOperation Group Response 
- 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.
- grpc_operation_ Googlegroup Cloud Apigee V1Grpc Operation Group Response 
- Optional. Configuration used to group Apigee proxies with gRPC services and method names. This grouping allows us to set quota for a particular proxy with the gRPC service name and method. If a method name is not set, this implies quota and authorization are applied to all gRPC methods implemented by that proxy for that particular gRPC service.
- last_modified_ strat 
- Response only. Modified time of this environment as milliseconds since epoch.
- name str
- 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.
- operation_group GoogleCloud Apigee V1Operation Group Response 
- 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 quotasetting). Note: Theapi_resourcessetting cannot be specified for both the API product and operation group; otherwise the call will fail.
- proxies Sequence[str]
- 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 str
- Number of request messages permitted per app by this API product for the specified quotaIntervalandquotaTimeUnit. For example, aquotaof 50, for aquotaIntervalof 12 and aquotaTimeUnitof hours means 50 requests are allowed every 12 hours.
- quota_counter_ strscope 
- Scope of the quota decides how the quota counter gets applied and evaluate for quota violation. If the Scope is set as PROXY, then all the operations defined for the APIproduct that are associated with the same proxy will share the same quota counter set at the APIproduct level, making it a global counter at a proxy level. If the Scope is set as OPERATION, then each operations get the counter set at the API product dedicated, making it a local counter. Note that, the QuotaCounterScope applies only when an operation does not have dedicated quota set for itself.
- quota_interval str
- Time interval over which the number of request messages is calculated.
- quota_time_ strunit 
- Time unit defined for the quotaInterval. Valid values includeminute,hour,day, ormonth.
- scopes Sequence[str]
- 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.
- apiResources List<String>
- Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the proxy.pathsuffixvariable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if theapiResourceselement is defined to be/forecastrssand the base path defined for the API proxy is/weather, then only requests to/weather/forecastrssare 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/weatherapikeyand to any sub-URIs, such as/v1/weatherapikey/forecastrss,/v1/weatherapikey/region/CA, and so on. For more information, see Managing API products.
- approvalType String
- 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 toauto, the consumer key is generated and returned in "approved" state and can be used immediately. Note: Typically,autois used to provide access to free or trial API products that provide limited quota or capabilities.
- attributes List<Property Map>
- 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, orinternal. Only products markedpublicare available to developers in the Apigee developer portal. For example, you can set a product tointernalwhile it is in development and then change access topublicwhen it is ready to release on the portal. API products marked asprivatedo not appear on the portal, but can be accessed by external developers.
- createdAt String
- Response only. Creation time of this environment as milliseconds since epoch.
- description String
- Description of the API product. Include key information about the API product that is not captured by other fields.
- displayName String
- Name displayed in the UI or developer portal to developers registering for API access.
- environments List<String>
- 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 prodfrom being accessed by API proxies deployed intest.
- graphqlOperation Property MapGroup 
- 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.
- grpcOperation Property MapGroup 
- Optional. Configuration used to group Apigee proxies with gRPC services and method names. This grouping allows us to set quota for a particular proxy with the gRPC service name and method. If a method name is not set, this implies quota and authorization are applied to all gRPC methods implemented by that proxy for that particular gRPC service.
- lastModified StringAt 
- Response only. Modified time of this environment as milliseconds since epoch.
- name String
- 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 Property Map
- 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 quotasetting). Note: Theapi_resourcessetting cannot be specified for both the API product and operation group; otherwise the call will fail.
- proxies List<String>
- 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 String
- Number of request messages permitted per app by this API product for the specified quotaIntervalandquotaTimeUnit. For example, aquotaof 50, for aquotaIntervalof 12 and aquotaTimeUnitof hours means 50 requests are allowed every 12 hours.
- quotaCounter StringScope 
- Scope of the quota decides how the quota counter gets applied and evaluate for quota violation. If the Scope is set as PROXY, then all the operations defined for the APIproduct that are associated with the same proxy will share the same quota counter set at the APIproduct level, making it a global counter at a proxy level. If the Scope is set as OPERATION, then each operations get the counter set at the API product dedicated, making it a local counter. Note that, the QuotaCounterScope applies only when an operation does not have dedicated quota set for itself.
- quotaInterval String
- Time interval over which the number of request messages is calculated.
- quotaTime StringUnit 
- Time unit defined for the quotaInterval. Valid values includeminute,hour,day, ormonth.
- scopes List<String>
- 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.
Supporting Types
GoogleCloudApigeeV1AttributeResponse    
GoogleCloudApigeeV1GraphQLOperationConfigResponse      
- ApiSource string
- Name of the API proxy endpoint or remote service with which the GraphQL operation and quota are associated.
- Attributes
List<Pulumi.Google Native. Apigee. V1. Inputs. Google Cloud Apigee V1Attribute Response> 
- Custom attributes associated with the operation.
- Operations
List<Pulumi.Google Native. Apigee. V1. Inputs. Google Cloud Apigee V1Graph QLOperation Response> 
- List of GraphQL name/operation type pairs for the proxy or remote service to which quota will be applied. If only operation types are specified, the quota will be applied to all GraphQL requests irrespective of the GraphQL name. Note: Currently, you can specify only a single GraphQLOperation. Specifying more than one will cause the operation to fail.
- Quota
Pulumi.Google Native. Apigee. V1. Inputs. Google Cloud Apigee V1Quota Response 
- Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.
- ApiSource string
- Name of the API proxy endpoint or remote service with which the GraphQL operation and quota are associated.
- Attributes
[]GoogleCloud Apigee V1Attribute Response 
- Custom attributes associated with the operation.
- Operations
[]GoogleCloud Apigee V1Graph QLOperation Response 
- List of GraphQL name/operation type pairs for the proxy or remote service to which quota will be applied. If only operation types are specified, the quota will be applied to all GraphQL requests irrespective of the GraphQL name. Note: Currently, you can specify only a single GraphQLOperation. Specifying more than one will cause the operation to fail.
- Quota
GoogleCloud Apigee V1Quota Response 
- Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.
- apiSource String
- Name of the API proxy endpoint or remote service with which the GraphQL operation and quota are associated.
- attributes
List<GoogleCloud Apigee V1Attribute Response> 
- Custom attributes associated with the operation.
- operations
List<GoogleCloud Apigee V1Graph QLOperation Response> 
- List of GraphQL name/operation type pairs for the proxy or remote service to which quota will be applied. If only operation types are specified, the quota will be applied to all GraphQL requests irrespective of the GraphQL name. Note: Currently, you can specify only a single GraphQLOperation. Specifying more than one will cause the operation to fail.
- quota
GoogleCloud Apigee V1Quota Response 
- Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.
- apiSource string
- Name of the API proxy endpoint or remote service with which the GraphQL operation and quota are associated.
- attributes
GoogleCloud Apigee V1Attribute Response[] 
- Custom attributes associated with the operation.
- operations
GoogleCloud Apigee V1Graph QLOperation Response[] 
- List of GraphQL name/operation type pairs for the proxy or remote service to which quota will be applied. If only operation types are specified, the quota will be applied to all GraphQL requests irrespective of the GraphQL name. Note: Currently, you can specify only a single GraphQLOperation. Specifying more than one will cause the operation to fail.
- quota
GoogleCloud Apigee V1Quota Response 
- Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.
- api_source str
- Name of the API proxy endpoint or remote service with which the GraphQL operation and quota are associated.
- attributes
Sequence[GoogleCloud Apigee V1Attribute Response] 
- Custom attributes associated with the operation.
- operations
Sequence[GoogleCloud Apigee V1Graph QLOperation Response] 
- List of GraphQL name/operation type pairs for the proxy or remote service to which quota will be applied. If only operation types are specified, the quota will be applied to all GraphQL requests irrespective of the GraphQL name. Note: Currently, you can specify only a single GraphQLOperation. Specifying more than one will cause the operation to fail.
- quota
GoogleCloud Apigee V1Quota Response 
- Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.
- apiSource String
- Name of the API proxy endpoint or remote service with which the GraphQL operation and quota are associated.
- attributes List<Property Map>
- Custom attributes associated with the operation.
- operations List<Property Map>
- List of GraphQL name/operation type pairs for the proxy or remote service to which quota will be applied. If only operation types are specified, the quota will be applied to all GraphQL requests irrespective of the GraphQL name. Note: Currently, you can specify only a single GraphQLOperation. Specifying more than one will cause the operation to fail.
- quota Property Map
- Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.
GoogleCloudApigeeV1GraphQLOperationGroupResponse      
- OperationConfig stringType 
- Flag that specifies whether the configuration is for Apigee API proxy or a remote service. Valid values include proxyorremoteservice. Defaults toproxy. Set toproxywhen Apigee API proxies are associated with the API product. Set toremoteservicewhen non-Apigee proxies like Istio-Envoy are associated with the API product.
- OperationConfigs List<Pulumi.Google Native. Apigee. V1. Inputs. Google Cloud Apigee V1Graph QLOperation Config Response> 
- List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.
- OperationConfig stringType 
- Flag that specifies whether the configuration is for Apigee API proxy or a remote service. Valid values include proxyorremoteservice. Defaults toproxy. Set toproxywhen Apigee API proxies are associated with the API product. Set toremoteservicewhen non-Apigee proxies like Istio-Envoy are associated with the API product.
- OperationConfigs []GoogleCloud Apigee V1Graph QLOperation Config Response 
- List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.
- operationConfig StringType 
- Flag that specifies whether the configuration is for Apigee API proxy or a remote service. Valid values include proxyorremoteservice. Defaults toproxy. Set toproxywhen Apigee API proxies are associated with the API product. Set toremoteservicewhen non-Apigee proxies like Istio-Envoy are associated with the API product.
- operationConfigs List<GoogleCloud Apigee V1Graph QLOperation Config Response> 
- List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.
- operationConfig stringType 
- Flag that specifies whether the configuration is for Apigee API proxy or a remote service. Valid values include proxyorremoteservice. Defaults toproxy. Set toproxywhen Apigee API proxies are associated with the API product. Set toremoteservicewhen non-Apigee proxies like Istio-Envoy are associated with the API product.
- operationConfigs GoogleCloud Apigee V1Graph QLOperation Config Response[] 
- List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.
- operation_config_ strtype 
- Flag that specifies whether the configuration is for Apigee API proxy or a remote service. Valid values include proxyorremoteservice. Defaults toproxy. Set toproxywhen Apigee API proxies are associated with the API product. Set toremoteservicewhen non-Apigee proxies like Istio-Envoy are associated with the API product.
- operation_configs Sequence[GoogleCloud Apigee V1Graph QLOperation Config Response] 
- List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.
- operationConfig StringType 
- Flag that specifies whether the configuration is for Apigee API proxy or a remote service. Valid values include proxyorremoteservice. Defaults toproxy. Set toproxywhen Apigee API proxies are associated with the API product. Set toremoteservicewhen non-Apigee proxies like Istio-Envoy are associated with the API product.
- operationConfigs List<Property Map>
- List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.
GoogleCloudApigeeV1GraphQLOperationResponse     
- Operation string
- GraphQL operation name. The name and operation type will be used to apply quotas. If no name is specified, the quota will be applied to all GraphQL operations irrespective of their operation names in the payload.
- OperationTypes List<string>
- GraphQL operation types. Valid values include queryormutation. Note: Apigee does not currently supportsubscriptiontypes.
- Operation string
- GraphQL operation name. The name and operation type will be used to apply quotas. If no name is specified, the quota will be applied to all GraphQL operations irrespective of their operation names in the payload.
- OperationTypes []string
- GraphQL operation types. Valid values include queryormutation. Note: Apigee does not currently supportsubscriptiontypes.
- operation String
- GraphQL operation name. The name and operation type will be used to apply quotas. If no name is specified, the quota will be applied to all GraphQL operations irrespective of their operation names in the payload.
- operationTypes List<String>
- GraphQL operation types. Valid values include queryormutation. Note: Apigee does not currently supportsubscriptiontypes.
- operation string
- GraphQL operation name. The name and operation type will be used to apply quotas. If no name is specified, the quota will be applied to all GraphQL operations irrespective of their operation names in the payload.
- operationTypes string[]
- GraphQL operation types. Valid values include queryormutation. Note: Apigee does not currently supportsubscriptiontypes.
- operation str
- GraphQL operation name. The name and operation type will be used to apply quotas. If no name is specified, the quota will be applied to all GraphQL operations irrespective of their operation names in the payload.
- operation_types Sequence[str]
- GraphQL operation types. Valid values include queryormutation. Note: Apigee does not currently supportsubscriptiontypes.
- operation String
- GraphQL operation name. The name and operation type will be used to apply quotas. If no name is specified, the quota will be applied to all GraphQL operations irrespective of their operation names in the payload.
- operationTypes List<String>
- GraphQL operation types. Valid values include queryormutation. Note: Apigee does not currently supportsubscriptiontypes.
GoogleCloudApigeeV1GrpcOperationConfigResponse      
- ApiSource string
- Name of the API proxy with which the gRPC operation and quota are associated.
- Attributes
List<Pulumi.Google Native. Apigee. V1. Inputs. Google Cloud Apigee V1Attribute Response> 
- Custom attributes associated with the operation.
- Methods List<string>
- List of unqualified gRPC method names for the proxy to which quota will be applied. If this field is empty, the Quota will apply to all operations on the gRPC service defined on the proxy. Example: Given a proxy that is configured to serve com.petstore.PetService, the methods com.petstore.PetService.ListPets and com.petstore.PetService.GetPet would be specified here as simply ["ListPets", "GetPet"].
- Quota
Pulumi.Google Native. Apigee. V1. Inputs. Google Cloud Apigee V1Quota Response 
- Quota parameters to be enforced for the methods and API source combination. If none are specified, quota enforcement will not be done.
- Service string
- gRPC Service name associated to be associated with the API proxy, on which quota rules can be applied upon.
- ApiSource string
- Name of the API proxy with which the gRPC operation and quota are associated.
- Attributes
[]GoogleCloud Apigee V1Attribute Response 
- Custom attributes associated with the operation.
- Methods []string
- List of unqualified gRPC method names for the proxy to which quota will be applied. If this field is empty, the Quota will apply to all operations on the gRPC service defined on the proxy. Example: Given a proxy that is configured to serve com.petstore.PetService, the methods com.petstore.PetService.ListPets and com.petstore.PetService.GetPet would be specified here as simply ["ListPets", "GetPet"].
- Quota
GoogleCloud Apigee V1Quota Response 
- Quota parameters to be enforced for the methods and API source combination. If none are specified, quota enforcement will not be done.
- Service string
- gRPC Service name associated to be associated with the API proxy, on which quota rules can be applied upon.
- apiSource String
- Name of the API proxy with which the gRPC operation and quota are associated.
- attributes
List<GoogleCloud Apigee V1Attribute Response> 
- Custom attributes associated with the operation.
- methods List<String>
- List of unqualified gRPC method names for the proxy to which quota will be applied. If this field is empty, the Quota will apply to all operations on the gRPC service defined on the proxy. Example: Given a proxy that is configured to serve com.petstore.PetService, the methods com.petstore.PetService.ListPets and com.petstore.PetService.GetPet would be specified here as simply ["ListPets", "GetPet"].
- quota
GoogleCloud Apigee V1Quota Response 
- Quota parameters to be enforced for the methods and API source combination. If none are specified, quota enforcement will not be done.
- service String
- gRPC Service name associated to be associated with the API proxy, on which quota rules can be applied upon.
- apiSource string
- Name of the API proxy with which the gRPC operation and quota are associated.
- attributes
GoogleCloud Apigee V1Attribute Response[] 
- Custom attributes associated with the operation.
- methods string[]
- List of unqualified gRPC method names for the proxy to which quota will be applied. If this field is empty, the Quota will apply to all operations on the gRPC service defined on the proxy. Example: Given a proxy that is configured to serve com.petstore.PetService, the methods com.petstore.PetService.ListPets and com.petstore.PetService.GetPet would be specified here as simply ["ListPets", "GetPet"].
- quota
GoogleCloud Apigee V1Quota Response 
- Quota parameters to be enforced for the methods and API source combination. If none are specified, quota enforcement will not be done.
- service string
- gRPC Service name associated to be associated with the API proxy, on which quota rules can be applied upon.
- api_source str
- Name of the API proxy with which the gRPC operation and quota are associated.
- attributes
Sequence[GoogleCloud Apigee V1Attribute Response] 
- Custom attributes associated with the operation.
- methods Sequence[str]
- List of unqualified gRPC method names for the proxy to which quota will be applied. If this field is empty, the Quota will apply to all operations on the gRPC service defined on the proxy. Example: Given a proxy that is configured to serve com.petstore.PetService, the methods com.petstore.PetService.ListPets and com.petstore.PetService.GetPet would be specified here as simply ["ListPets", "GetPet"].
- quota
GoogleCloud Apigee V1Quota Response 
- Quota parameters to be enforced for the methods and API source combination. If none are specified, quota enforcement will not be done.
- service str
- gRPC Service name associated to be associated with the API proxy, on which quota rules can be applied upon.
- apiSource String
- Name of the API proxy with which the gRPC operation and quota are associated.
- attributes List<Property Map>
- Custom attributes associated with the operation.
- methods List<String>
- List of unqualified gRPC method names for the proxy to which quota will be applied. If this field is empty, the Quota will apply to all operations on the gRPC service defined on the proxy. Example: Given a proxy that is configured to serve com.petstore.PetService, the methods com.petstore.PetService.ListPets and com.petstore.PetService.GetPet would be specified here as simply ["ListPets", "GetPet"].
- quota Property Map
- Quota parameters to be enforced for the methods and API source combination. If none are specified, quota enforcement will not be done.
- service String
- gRPC Service name associated to be associated with the API proxy, on which quota rules can be applied upon.
GoogleCloudApigeeV1GrpcOperationGroupResponse      
- OperationConfigs List<Pulumi.Google Native. Apigee. V1. Inputs. Google Cloud Apigee V1Grpc Operation Config Response> 
- List of operation configurations for either Apigee API proxies that are associated with this API product.
- OperationConfigs []GoogleCloud Apigee V1Grpc Operation Config Response 
- List of operation configurations for either Apigee API proxies that are associated with this API product.
- operationConfigs List<GoogleCloud Apigee V1Grpc Operation Config Response> 
- List of operation configurations for either Apigee API proxies that are associated with this API product.
- operationConfigs GoogleCloud Apigee V1Grpc Operation Config Response[] 
- List of operation configurations for either Apigee API proxies that are associated with this API product.
- operation_configs Sequence[GoogleCloud Apigee V1Grpc Operation Config Response] 
- List of operation configurations for either Apigee API proxies that are associated with this API product.
- operationConfigs List<Property Map>
- List of operation configurations for either Apigee API proxies that are associated with this API product.
GoogleCloudApigeeV1OperationConfigResponse     
- ApiSource string
- Name of the API proxy or remote service with which the resources, methods, and quota are associated.
- Attributes
List<Pulumi.Google Native. Apigee. V1. Inputs. Google Cloud Apigee V1Attribute Response> 
- Custom attributes associated with the operation.
- Operations
List<Pulumi.Google Native. Apigee. V1. Inputs. Google Cloud Apigee V1Operation Response> 
- List of resource/method pairs for the API proxy or remote service to which quota will applied. Note: Currently, you can specify only a single resource/method pair. The call will fail if more than one resource/method pair is provided.
- Quota
Pulumi.Google Native. Apigee. V1. Inputs. Google Cloud Apigee V1Quota Response 
- Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.
- ApiSource string
- Name of the API proxy or remote service with which the resources, methods, and quota are associated.
- Attributes
[]GoogleCloud Apigee V1Attribute Response 
- Custom attributes associated with the operation.
- Operations
[]GoogleCloud Apigee V1Operation Response 
- List of resource/method pairs for the API proxy or remote service to which quota will applied. Note: Currently, you can specify only a single resource/method pair. The call will fail if more than one resource/method pair is provided.
- Quota
GoogleCloud Apigee V1Quota Response 
- Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.
- apiSource String
- Name of the API proxy or remote service with which the resources, methods, and quota are associated.
- attributes
List<GoogleCloud Apigee V1Attribute Response> 
- Custom attributes associated with the operation.
- operations
List<GoogleCloud Apigee V1Operation Response> 
- List of resource/method pairs for the API proxy or remote service to which quota will applied. Note: Currently, you can specify only a single resource/method pair. The call will fail if more than one resource/method pair is provided.
- quota
GoogleCloud Apigee V1Quota Response 
- Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.
- apiSource string
- Name of the API proxy or remote service with which the resources, methods, and quota are associated.
- attributes
GoogleCloud Apigee V1Attribute Response[] 
- Custom attributes associated with the operation.
- operations
GoogleCloud Apigee V1Operation Response[] 
- List of resource/method pairs for the API proxy or remote service to which quota will applied. Note: Currently, you can specify only a single resource/method pair. The call will fail if more than one resource/method pair is provided.
- quota
GoogleCloud Apigee V1Quota Response 
- Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.
- api_source str
- Name of the API proxy or remote service with which the resources, methods, and quota are associated.
- attributes
Sequence[GoogleCloud Apigee V1Attribute Response] 
- Custom attributes associated with the operation.
- operations
Sequence[GoogleCloud Apigee V1Operation Response] 
- List of resource/method pairs for the API proxy or remote service to which quota will applied. Note: Currently, you can specify only a single resource/method pair. The call will fail if more than one resource/method pair is provided.
- quota
GoogleCloud Apigee V1Quota Response 
- Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.
- apiSource String
- Name of the API proxy or remote service with which the resources, methods, and quota are associated.
- attributes List<Property Map>
- Custom attributes associated with the operation.
- operations List<Property Map>
- List of resource/method pairs for the API proxy or remote service to which quota will applied. Note: Currently, you can specify only a single resource/method pair. The call will fail if more than one resource/method pair is provided.
- quota Property Map
- Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.
GoogleCloudApigeeV1OperationGroupResponse     
- OperationConfig stringType 
- Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values include proxyorremoteservice. Defaults toproxy. Set toproxywhen Apigee API proxies are associated with the API product. Set toremoteservicewhen non-Apigee proxies like Istio-Envoy are associated with the API product.
- OperationConfigs List<Pulumi.Google Native. Apigee. V1. Inputs. Google Cloud Apigee V1Operation Config Response> 
- List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.
- OperationConfig stringType 
- Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values include proxyorremoteservice. Defaults toproxy. Set toproxywhen Apigee API proxies are associated with the API product. Set toremoteservicewhen non-Apigee proxies like Istio-Envoy are associated with the API product.
- OperationConfigs []GoogleCloud Apigee V1Operation Config Response 
- List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.
- operationConfig StringType 
- Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values include proxyorremoteservice. Defaults toproxy. Set toproxywhen Apigee API proxies are associated with the API product. Set toremoteservicewhen non-Apigee proxies like Istio-Envoy are associated with the API product.
- operationConfigs List<GoogleCloud Apigee V1Operation Config Response> 
- List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.
- operationConfig stringType 
- Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values include proxyorremoteservice. Defaults toproxy. Set toproxywhen Apigee API proxies are associated with the API product. Set toremoteservicewhen non-Apigee proxies like Istio-Envoy are associated with the API product.
- operationConfigs GoogleCloud Apigee V1Operation Config Response[] 
- List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.
- operation_config_ strtype 
- Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values include proxyorremoteservice. Defaults toproxy. Set toproxywhen Apigee API proxies are associated with the API product. Set toremoteservicewhen non-Apigee proxies like Istio-Envoy are associated with the API product.
- operation_configs Sequence[GoogleCloud Apigee V1Operation Config Response] 
- List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.
- operationConfig StringType 
- Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values include proxyorremoteservice. Defaults toproxy. Set toproxywhen Apigee API proxies are associated with the API product. Set toremoteservicewhen non-Apigee proxies like Istio-Envoy are associated with the API product.
- operationConfigs List<Property Map>
- List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.
GoogleCloudApigeeV1OperationResponse    
GoogleCloudApigeeV1QuotaResponse    
- Interval string
- Time interval over which the number of request messages is calculated.
- Limit string
- Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.
- TimeUnit string
- Time unit defined for the interval. Valid values includeminute,hour,day, ormonth. Iflimitandintervalare valid, the default value ishour; otherwise, the default is null.
- Interval string
- Time interval over which the number of request messages is calculated.
- Limit string
- Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.
- TimeUnit string
- Time unit defined for the interval. Valid values includeminute,hour,day, ormonth. Iflimitandintervalare valid, the default value ishour; otherwise, the default is null.
- interval String
- Time interval over which the number of request messages is calculated.
- limit String
- Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.
- timeUnit String
- Time unit defined for the interval. Valid values includeminute,hour,day, ormonth. Iflimitandintervalare valid, the default value ishour; otherwise, the default is null.
- interval string
- Time interval over which the number of request messages is calculated.
- limit string
- Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.
- timeUnit string
- Time unit defined for the interval. Valid values includeminute,hour,day, ormonth. Iflimitandintervalare valid, the default value ishour; otherwise, the default is null.
- interval str
- Time interval over which the number of request messages is calculated.
- limit str
- Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.
- time_unit str
- Time unit defined for the interval. Valid values includeminute,hour,day, ormonth. Iflimitandintervalare valid, the default value ishour; otherwise, the default is null.
- interval String
- Time interval over which the number of request messages is calculated.
- limit String
- Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.
- timeUnit String
- Time unit defined for the interval. Valid values includeminute,hour,day, ormonth. Iflimitandintervalare valid, the default value ishour; otherwise, the default is null.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.