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

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleCloudApigeeV1ApiProduct

Returns a new instance of GoogleCloudApigeeV1ApiProduct.


390
391
392
# File 'generated/google/apis/apigee_v1/classes.rb', line 390

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

Instance Attribute Details

#api_resourcesArray<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: - Manage API products - Managing a transaction recording policy using the API Corresponds to the JSON property apiResources

Returns:

  • (Array<String>)

279
280
281
# File 'generated/google/apis/apigee_v1/classes.rb', line 279

def api_resources
  @api_resources
end

#approval_typeString

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)

290
291
292
# File 'generated/google/apis/apigee_v1/classes.rb', line 290

def approval_type
  @approval_type
end

#attributesArray<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. For monetization, you can use the attributes field to: - Specify transaction success criteria - Specify custom attributes on which you base rate plan charges. Corresponds to the JSON property attributes


305
306
307
# File 'generated/google/apis/apigee_v1/classes.rb', line 305

def attributes
  @attributes
end

#created_atFixnum

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

Returns:

  • (Fixnum)

310
311
312
# File 'generated/google/apis/apigee_v1/classes.rb', line 310

def created_at
  @created_at
end

#descriptionString

An overview 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)

316
317
318
# File 'generated/google/apis/apigee_v1/classes.rb', line 316

def description
  @description
end

#display_nameString

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

Returns:

  • (String)

322
323
324
# File 'generated/google/apis/apigee_v1/classes.rb', line 322

def display_name
  @display_name
end

#environmentsArray<String>

A 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>)

333
334
335
# File 'generated/google/apis/apigee_v1/classes.rb', line 333

def environments
  @environments
end

#last_modified_atFixnum

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

Returns:

  • (Fixnum)

338
339
340
# File 'generated/google/apis/apigee_v1/classes.rb', line 338

def last_modified_at
  @last_modified_at
end

#nameString

The 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)

345
346
347
# File 'generated/google/apis/apigee_v1/classes.rb', line 345

def name
  @name
end

#operation_groupGoogle::Apis::ApigeeV1::GoogleCloudApigeeV1OperationGroup

The OperationGroup contains a list of configuration details associated with Apigee proxies or Remote services. Remote services are non-Apigee Edge proxies. eg, Istio-Envoy. Corresponds to the JSON property operationGroup


352
353
354
# File 'generated/google/apis/apigee_v1/classes.rb', line 352

def operation_group
  @operation_group
end

#proxiesArray<String>

A 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. Edge 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>)

362
363
364
# File 'generated/google/apis/apigee_v1/classes.rb', line 362

def proxies
  @proxies
end

#quotaString

The 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)

370
371
372
# File 'generated/google/apis/apigee_v1/classes.rb', line 370

def quota
  @quota
end

#quota_intervalString

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

Returns:

  • (String)

375
376
377
# File 'generated/google/apis/apigee_v1/classes.rb', line 375

def quota_interval
  @quota_interval
end

#quota_time_unitString

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

Returns:

  • (String)

381
382
383
# File 'generated/google/apis/apigee_v1/classes.rb', line 381

def quota_time_unit
  @quota_time_unit
end

#scopesArray<String>

A comma-separated list of OAuth scopes that are validated at runtime. Edge validates that the scopes in any access token presented match the scopes defined in the OAuth policy assoicated with the API product. Corresponds to the JSON property scopes

Returns:

  • (Array<String>)

388
389
390
# File 'generated/google/apis/apigee_v1/classes.rb', line 388

def scopes
  @scopes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
# File 'generated/google/apis/apigee_v1/classes.rb', line 395

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)
  @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_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