Class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/apigee_v1/classes.rb,
lib/google/apis/apigee_v1/representations.rb,
lib/google/apis/apigee_v1/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudApigeeV1ApiProduct

Returns a new instance of GoogleCloudApigeeV1ApiProduct.



658
659
660
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 658

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#api_resources ⇒ Array<String>

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. Corresponds to the JSON property apiResources

Returns:

  • (Array<String>) 


531
532
533
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 531

def api_resources
  @api_resources
end

#approval_type ⇒ 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 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. Corresponds to the JSON property approvalType

Returns:

  • (String) 


542
543
544
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 542

def approval_type
  @approval_type
end

#attributes ⇒ Array<Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute>

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. Corresponds to the JSON property attributes

Returns:



555
556
557
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 555

def attributes
  @attributes
end

#created_at ⇒ Fixnum

Response only. Creation time of this environment as milliseconds since epoch. Corresponds to the JSON property createdAt

Returns:

  • (Fixnum) 


560
561
562
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 560

def created_at
  @created_at
end

#description ⇒ String

Description of the API product. Include key information about the API product that is not captured by other fields. Corresponds to the JSON property description

Returns:

  • (String) 


566
567
568
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 566

def description
  @description
end

#display_name ⇒ String

Name displayed in the UI or developer portal to developers registering for API access. Corresponds to the JSON property displayName

Returns:

  • (String) 


572
573
574
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 572

def display_name
  @display_name
end

#environments ⇒ Array<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 prod from being accessed by API proxies deployed in test. Corresponds to the JSON property environments

Returns:

  • (Array<String>) 


583
584
585
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 583

def environments
  @environments
end

#graphql_operation_group ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1GraphQlOperationGroup

List of graphQL operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy. Corresponds to the JSON property graphqlOperationGroup

Returns:



590
591
592
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 590

def graphql_operation_group
  @graphql_operation_group
end

#last_modified_at ⇒ Fixnum

Response only. Modified time of this environment as milliseconds since epoch. Corresponds to the JSON property lastModifiedAt

Returns:

  • (Fixnum) 


595
596
597
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 595

def last_modified_at
  @last_modified_at
end

#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. Corresponds to the JSON property name

Returns:

  • (String) 


602
603
604
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 602

def name
  @name
end

#operation_group ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1OperationGroup

List of operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy. Corresponds to the JSON property operationGroup

Returns:



608
609
610
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 608

def operation_group
  @operation_group
end

#proxies ⇒ Array<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. Corresponds to the JSON property proxies

Returns:

  • (Array<String>) 


618
619
620
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 618

def proxies
  @proxies
end

#quota ⇒ String

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. Corresponds to the JSON property quota

Returns:

  • (String) 


626
627
628
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 626

def quota
  @quota
end

#quota_counter_scope ⇒ String

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. Corresponds to the JSON property quotaCounterScope

Returns:

  • (String) 


638
639
640
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 638

def quota_counter_scope
  @quota_counter_scope
end

#quota_interval ⇒ String

Time interval over which the number of request messages is calculated. Corresponds to the JSON property quotaInterval

Returns:

  • (String) 


643
644
645
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 643

def quota_interval
  @quota_interval
end

#quota_time_unit ⇒ String

Time unit defined for the quotaInterval. Valid values include minute, hour, day, or month. Corresponds to the JSON property quotaTimeUnit

Returns:

  • (String) 


649
650
651
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 649

def quota_time_unit
  @quota_time_unit
end

#scopes ⇒ Array<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. Corresponds to the JSON property scopes

Returns:

  • (Array<String>) 


656
657
658
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 656

def scopes
  @scopes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 663

def update!(**args)
  @api_resources = args[:api_resources] if args.key?(:api_resources)
  @approval_type = args[:approval_type] if args.key?(:approval_type)
  @attributes = args[:attributes] if args.key?(:attributes)
  @created_at = args[:created_at] if args.key?(:created_at)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @environments = args[:environments] if args.key?(:environments)
  @graphql_operation_group = args[:graphql_operation_group] if args.key?(:graphql_operation_group)
  @last_modified_at = args[:last_modified_at] if args.key?(:last_modified_at)
  @name = args[:name] if args.key?(:name)
  @operation_group = args[:operation_group] if args.key?(:operation_group)
  @proxies = args[:proxies] if args.key?(:proxies)
  @quota = args[:quota] if args.key?(:quota)
  @quota_counter_scope = args[:quota_counter_scope] if args.key?(:quota_counter_scope)
  @quota_interval = args[:quota_interval] if args.key?(:quota_interval)
  @quota_time_unit = args[:quota_time_unit] if args.key?(:quota_time_unit)
  @scopes = args[:scopes] if args.key?(:scopes)
end