Class: Google::Apis::ApigeeV1::ApigeeService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/apigee_v1/service.rb

Overview

Apigee API

Use the Apigee API to programmatically develop and manage APIs with a set of RESTful operations. Develop and secure API proxies, deploy and undeploy API proxy revisions, monitor APIs, configure environments, manage users, and more. Note: This product is available as a free trial for a time period of 60 days.

Examples:

require 'google/apis/apigee_v1'

Apigee = Google::Apis::ApigeeV1 # Alias the module
service = Apigee::ApigeeService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ApigeeService

Returns a new instance of ApigeeService.



48
49
50
51
52
53
 
# File 'lib/google/apis/apigee_v1/service.rb', line 48

def initialize
  super('https://apigee.googleapis.com/', '',
        client_name: 'google-apis-apigee_v1',
        client_version: Google::Apis::ApigeeV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



41
42
43
 
# File 'lib/google/apis/apigee_v1/service.rb', line 41

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



46
47
48
 
# File 'lib/google/apis/apigee_v1/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

#activate_organization_instance_nat_address(name, google_cloud_apigee_v1_activate_nat_address_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleLongrunningOperation

Activates the NAT address. The Apigee instance can now use this for Internet egress traffic. Note: Not supported for Apigee hybrid.

Parameters:

  • name (String) —

    Required. Name of the nat address. Use the following structure in your request: organizations/org/instances/instances/natAddresses/nataddress```

  • google_cloud_apigee_v1_activate_nat_address_request_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1ActivateNatAddressRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7123

def activate_organization_instance_nat_address(name, google_cloud_apigee_v1_activate_nat_address_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:activate', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ActivateNatAddressRequest::Representation
  command.request_object = google_cloud_apigee_v1_activate_nat_address_request_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#attach_organization_environment_flowhook_shared_flow_to_flow_hook(name, google_cloud_apigee_v1_flow_hook_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook

Attaches a shared flow to a flow hook.

Parameters:

  • name (String) —

    Required. Name of the flow hook to which the shared flow should be attached in the following format: organizations/org/environments/env/flowhooks/ flowhook``

  • google_cloud_apigee_v1_flow_hook_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4780

def attach_organization_environment_flowhook_shared_flow_to_flow_hook(name, google_cloud_apigee_v1_flow_hook_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook::Representation
  command.request_object = google_cloud_apigee_v1_flow_hook_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#attributes_organization_apiproduct(name, google_cloud_apigee_v1_attributes_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes

Updates or creates API product attributes. This API replaces the current list of attributes with the attributes specified in the request body. In this way, you can update existing attributes, add new attributes, or delete existing attributes by omitting them from the request body. Note: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with entities also get cached for at least 180 seconds after entity is accessed during runtime. In this case, the ExpiresIn element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.

Parameters:

  • name (String) —

    Required. Name of the API product. Use the following structure in your request: organizations/org/apiproducts/apiproduct``

  • google_cloud_apigee_v1_attributes_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



670
671
672
673
674
675
676
677
678
679
680
 
# File 'lib/google/apis/apigee_v1/service.rb', line 670

def attributes_organization_apiproduct(name, google_cloud_apigee_v1_attributes_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}/attributes', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes::Representation
  command.request_object = google_cloud_apigee_v1_attributes_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#attributes_organization_developer(parent, google_cloud_apigee_v1_attributes_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes

Updates developer attributes. This API replaces the existing attributes with those specified in the request. Add new attributes, and include or exclude any existing attributes that you want to retain or remove, respectively. The custom attribute limit is 18. Note: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an ExpiresIn element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.

Parameters:

  • parent (String) —

    Required. Email address of the developer for which attributes are being updated. Use the following structure in your request: organizations/org/ developers/developer_email``

  • google_cloud_apigee_v1_attributes_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1968

def attributes_organization_developer(parent, google_cloud_apigee_v1_attributes_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/attributes', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes::Representation
  command.request_object = google_cloud_apigee_v1_attributes_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#attributes_organization_developer_app(name, google_cloud_apigee_v1_attributes_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes

Updates attributes for a developer app. This API replaces the current attributes with those specified in the request.

Parameters:

  • name (String) —

    Required. Name of the developer app. Use the following structure in your request: organizations/org/developers/developer_email/apps/app``

  • google_cloud_apigee_v1_attributes_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2258

def attributes_organization_developer_app(name, google_cloud_apigee_v1_attributes_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}/attributes', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes::Representation
  command.request_object = google_cloud_apigee_v1_attributes_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization(google_cloud_apigee_v1_organization_object = nil, parent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleLongrunningOperation

Creates an Apigee organization. See Create an Apigee organization.

Parameters:

  • google_cloud_apigee_v1_organization_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization) (defaults to: nil)
  • parent (String) (defaults to: nil) —

    Required. Name of the GCP project in which to associate the Apigee organization. Pass the information as a query parameter using the following structure in your request: projects/

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/google/apis/apigee_v1/service.rb', line 111

def create_organization(google_cloud_apigee_v1_organization_object = nil, parent: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/organizations', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization::Representation
  command.request_object = google_cloud_apigee_v1_organization_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
  command.query['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_analytic_datastore(parent, google_cloud_apigee_v1_datastore_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore

Create a Datastore for an org

Parameters:

  • parent (String) —

    Required. The parent organization name. Must be of the form organizations/ org``.

  • google_cloud_apigee_v1_datastore_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/google/apis/apigee_v1/service.rb', line 461

def create_organization_analytic_datastore(parent, google_cloud_apigee_v1_datastore_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/analytics/datastores', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore::Representation
  command.request_object = google_cloud_apigee_v1_datastore_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_api(parent, google_api_http_body_object = nil, action: nil, name: nil, validate: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision

Creates an API proxy. The API proxy created will not be accessible at runtime until it is deployed to an environment. Create a new API proxy by setting the name query parameter to the name of the API proxy. Import an API proxy configuration bundle stored in zip format on your local machine to your organization by doing the following: * Set the name query parameter to the name of the API proxy. * Set the action query parameter to import. * Set the Content-Type header to multipart/form-data. * Pass as a file the name of API proxy configuration bundle stored in zip format on your local machine using the file form field. Note: To validate the API proxy configuration bundle only without importing it, set the action query parameter to validate. When importing an API proxy configuration bundle, if the API proxy does not exist, it will be created. If the API proxy exists, then a new revision is created. Invalid API proxy configurations are rejected, and a list of validation errors is returned to the client.

Parameters:

  • parent (String) —

    Required. Name of the organization in the following format: organizations/ org``

  • google_api_http_body_object (Google::Apis::ApigeeV1::GoogleApiHttpBody) (defaults to: nil)
  • action (String) (defaults to: nil) —

    Action to perform when importing an API proxy configuration bundle. Set this parameter to one of the following values: * import to import the API proxy configuration bundle. * validate to validate the API proxy configuration bundle without importing it.

  • name (String) (defaults to: nil) —

    Name of the API proxy. Restrict the characters used to: A-Za-z0-9._-

  • validate (Boolean) (defaults to: nil) —

    Ignored. All uploads are validated regardless of the value of this field. Maintained for compatibility with Apigee Edge API.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1273

def create_organization_api(parent, google_api_http_body_object = nil, action: nil, name: nil, validate: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/apis', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation
  command.request_object = google_api_http_body_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision
  command.params['parent'] = parent unless parent.nil?
  command.query['action'] = action unless action.nil?
  command.query['name'] = name unless name.nil?
  command.query['validate'] = validate unless validate.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_api_keyvaluemap(parent, google_cloud_apigee_v1_key_value_map_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap

Creates a key value map in an api proxy.

Parameters:

  • parent (String) —

    Required. The name of the environment in which to create the key value map. Must be of the form organizations/organization/apis/api``.

  • google_cloud_apigee_v1_key_value_map_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1442

def create_organization_api_keyvaluemap(parent, google_cloud_apigee_v1_key_value_map_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/keyvaluemaps', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap::Representation
  command.request_object = google_cloud_apigee_v1_key_value_map_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_apiproduct(parent, google_cloud_apigee_v1_api_product_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct

Creates an API product in an organization. You create API products after you have proxied backend services using API proxies. An API product is a collection of API resources combined with quota settings and metadata that you can use to deliver customized and productized API bundles to your developer community. This metadata can include: - Scope - Environments - API proxies - Extensible profile API products enable you repackage APIs on the fly, without having to do any additional coding or configuration. Apigee recommends that you start with a simple API product including only required elements. You then provision credentials to apps to enable them to start testing your APIs. After you have authentication and authorization working against a simple API product, you can iterate to create finer-grained API products, defining different sets of API resources for each API product. WARNING: - If you don't specify an API proxy in the request body, any app associated with the product can make calls to any API in your entire organization. - If you don't specify an environment in the request body, the product allows access to all environments. For more information, see What is an API product?

Parameters:

  • parent (String) —

    Required. Name of the organization in which the API product will be created. Use the following structure in your request: organizations/org``

  • google_cloud_apigee_v1_api_product_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



719
720
721
722
723
724
725
726
727
728
729
 
# File 'lib/google/apis/apigee_v1/service.rb', line 719

def create_organization_apiproduct(parent, google_cloud_apigee_v1_api_product_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/apiproducts', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct::Representation
  command.request_object = google_cloud_apigee_v1_api_product_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_apiproduct_rateplan(parent, google_cloud_apigee_v1_rate_plan_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan

Create a rate plan that is associated with an API product in an organization. Using rate plans, API product owners can monetize their API products by configuring one or more of the following: - Billing frequency - Initial setup fees for using an API product - Payment funding model (postpaid only) - Fixed recurring or consumption-based charges for using an API product - Revenue sharing with developer partners An API product can have multiple rate plans associated with it but only one rate plan can be active at any point of time. **Note: From the developer's perspective, they purchase API products not rate plans.

Parameters:

  • parent (String) —

    Required. Name of the API product that is associated with the rate plan. Use the following structure in your request: organizations/org/apiproducts/ apiproduct``

  • google_cloud_apigee_v1_rate_plan_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1063

def create_organization_apiproduct_rateplan(parent, google_cloud_apigee_v1_rate_plan_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/rateplans', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan::Representation
  command.request_object = google_cloud_apigee_v1_rate_plan_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_datacollector(parent, google_cloud_apigee_v1_data_collector_object = nil, data_collector_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataCollector

Creates a new data collector.

Parameters:

  • parent (String) —

    Required. Name of the organization in which to create the data collector in the following format: organizations/org``.

  • google_cloud_apigee_v1_data_collector_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataCollector) (defaults to: nil)
  • data_collector_id (String) (defaults to: nil) —

    ID of the data collector. Overrides any ID in the data collector resource. Must begin with dc_.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1751

def create_organization_datacollector(parent, google_cloud_apigee_v1_data_collector_object = nil, data_collector_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/datacollectors', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataCollector::Representation
  command.request_object = google_cloud_apigee_v1_data_collector_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataCollector::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataCollector
  command.params['parent'] = parent unless parent.nil?
  command.query['dataCollectorId'] = data_collector_id unless data_collector_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_developer(parent, google_cloud_apigee_v1_developer_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer

Creates a developer. Once created, the developer can register an app and obtain an API key. At creation time, a developer is set as active. To change the developer status, use the SetDeveloperStatus API.

Parameters:

  • parent (String) —

    Required. Name of the Apigee organization in which the developer is created. Use the following structure in your request: organizations/org``.

  • google_cloud_apigee_v1_developer_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2004

def create_organization_developer(parent, google_cloud_apigee_v1_developer_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/developers', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer::Representation
  command.request_object = google_cloud_apigee_v1_developer_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_developer_app(parent, google_cloud_apigee_v1_developer_app_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp

Creates an app associated with a developer. This API associates the developer app with the specified API product and auto-generates an API key for the app to use in calls to API proxies inside that API product. The name is the unique ID of the app that you can use in API calls. The DisplayName (set as an attribute) appears in the UI. If you don't set the DisplayName attribute, the name appears in the UI.

Parameters:

  • parent (String) —

    Required. Name of the developer. Use the following structure in your request: organizations/org/developers/developer_email``

  • google_cloud_apigee_v1_developer_app_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2297

def create_organization_developer_app(parent, google_cloud_apigee_v1_developer_app_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/apps', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp::Representation
  command.request_object = google_cloud_apigee_v1_developer_app_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_developer_app_key(parent, google_cloud_apigee_v1_developer_app_key_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey

Creates a custom consumer key and secret for a developer app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee from another system. Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed. To avoid service disruptions, a consumer key and secret should not exceed 2 KBs each. Note: When creating the consumer key and secret, an association to API products will not be made. Therefore, you should not specify the associated API products in your request. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created. If a consumer key and secret already exist, you can keep them or delete them using the DeleteDeveloperAppKey API.

Parameters:

  • parent (String) —

    Parent of the developer app key. Use the following structure in your request: organizations/org/developers/developer_email/apps

  • google_cloud_apigee_v1_developer_app_key_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2707

def create_organization_developer_app_key(parent, google_cloud_apigee_v1_developer_app_key_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/keys', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation
  command.request_object = google_cloud_apigee_v1_developer_app_key_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_developer_app_key_create(parent, google_cloud_apigee_v1_developer_app_key_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey

Creates a custom consumer key and secret for a developer app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee from another system. Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed. To avoid service disruptions, a consumer key and secret should not exceed 2 KBs each. Note: When creating the consumer key and secret, an association to API products will not be made. Therefore, you should not specify the associated API products in your request. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created. If a consumer key and secret already exist, you can keep them or delete them using the DeleteDeveloperAppKey API.

Parameters:

  • parent (String) —

    Parent of the developer app key. Use the following structure in your request: organizations/org/developers/developer_email/apps

  • google_cloud_apigee_v1_developer_app_key_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2976

def create_organization_developer_app_key_create(parent, google_cloud_apigee_v1_developer_app_key_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/keys/create', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation
  command.request_object = google_cloud_apigee_v1_developer_app_key_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_developer_subscription(parent, google_cloud_apigee_v1_developer_subscription_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperSubscription

Creates a subscription to an API product.

Parameters:

  • parent (String) —

    Required. Email address of the developer that is purchasing a subscription to the API product. Use the following structure in your request: organizations/ org/developers/developer_email``

  • google_cloud_apigee_v1_developer_subscription_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperSubscription) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3147

def create_organization_developer_subscription(parent, google_cloud_apigee_v1_developer_subscription_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/subscriptions', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperSubscription::Representation
  command.request_object = google_cloud_apigee_v1_developer_subscription_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperSubscription::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperSubscription
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_envgroup(parent, google_cloud_apigee_v1_environment_group_object = nil, name: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleLongrunningOperation

Creates a new environment group.

Parameters:

  • parent (String) —

    Required. Name of the organization in which to create the environment group in the following format: organizations/org``.

  • google_cloud_apigee_v1_environment_group_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentGroup) (defaults to: nil)
  • name (String) (defaults to: nil) —

    ID of the environment group. Overrides any ID in the environment_group resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3293

def create_organization_envgroup(parent, google_cloud_apigee_v1_environment_group_object = nil, name: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/envgroups', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentGroup::Representation
  command.request_object = google_cloud_apigee_v1_environment_group_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_envgroup_attachment(parent, google_cloud_apigee_v1_environment_group_attachment_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleLongrunningOperation

Creates a new attachment of an environment to an environment group.

Parameters:

  • parent (String) —

    Required. EnvironmentGroup under which to create the attachment in the following format: organizations/org/envgroups/envgroup``.

  • google_cloud_apigee_v1_environment_group_attachment_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentGroupAttachment) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3465

def create_organization_envgroup_attachment(parent, google_cloud_apigee_v1_environment_group_attachment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/attachments', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentGroupAttachment::Representation
  command.request_object = google_cloud_apigee_v1_environment_group_attachment_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_environment(parent, google_cloud_apigee_v1_environment_object = nil, name: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleLongrunningOperation

Creates an environment in an organization.

Parameters:

  • parent (String) —

    Required. Name of the organization in which the environment will be created. Use the following structure in your request: organizations/org``

  • google_cloud_apigee_v1_environment_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment) (defaults to: nil)
  • name (String) (defaults to: nil) —

    Optional. Name of the environment. Alternatively, the name may be specified in the request body in the name field.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3603

def create_organization_environment(parent, google_cloud_apigee_v1_environment_object = nil, name: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/environments', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment::Representation
  command.request_object = google_cloud_apigee_v1_environment_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_environment_analytic_export(parent, google_cloud_apigee_v1_export_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Export

Submit a data export job to be processed in the background. If the request is successful, the API returns a 201 status, a URI that can be used to retrieve the status of the export job, and the state value of "enqueued".

Parameters:

  • parent (String) —

    Required. Names of the parent organization and environment. Must be of the form organizations/org/environments/env``.

  • google_cloud_apigee_v1_export_request_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1ExportRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4178

def create_organization_environment_analytic_export(parent, google_cloud_apigee_v1_export_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/analytics/exports', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ExportRequest::Representation
  command.request_object = google_cloud_apigee_v1_export_request_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Export::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Export
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_environment_api_revision_debugsession(parent, google_cloud_apigee_v1_debug_session_object = nil, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSession

Creates a debug session for a deployed API Proxy revision.

Parameters:

  • parent (String) —

    Required. The resource name of the API Proxy revision deployment for which to create the DebugSession. Must be of the form organizations/organization/ environments/environment/apis/api/revisions/revision``.

  • google_cloud_apigee_v1_debug_session_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSession) (defaults to: nil)
  • timeout (Fixnum) (defaults to: nil) —

    Optional. The time in seconds after which this DebugSession should end. A timeout specified in DebugSession will overwrite this value.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4453

def create_organization_environment_api_revision_debugsession(parent, google_cloud_apigee_v1_debug_session_object = nil, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/debugsessions', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSession::Representation
  command.request_object = google_cloud_apigee_v1_debug_session_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSession::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSession
  command.params['parent'] = parent unless parent.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_environment_keystore(parent, google_cloud_apigee_v1_keystore_object = nil, name: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore

Creates a keystore or truststore. - Keystore: Contains certificates and their associated keys. - Truststore: Contains trusted certificates used to validate a server's certificate. These certificates are typically self-signed certificates or certificates that are not signed by a trusted CA.

Parameters:

  • parent (String) —

    Required. Name of the environment in which to create the keystore. Use the following format in your request: organizations/org/environments/env``

  • google_cloud_apigee_v1_keystore_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore) (defaults to: nil)
  • name (String) (defaults to: nil) —

    Optional. Name of the keystore. Overrides the value in Keystore.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4883

def create_organization_environment_keystore(parent, google_cloud_apigee_v1_keystore_object = nil, name: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/keystores', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore::Representation
  command.request_object = google_cloud_apigee_v1_keystore_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore
  command.params['parent'] = parent unless parent.nil?
  command.query['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_environment_keystore_alias(parent, google_api_http_body_object = nil, _password: nil, alias_: nil, format: nil, ignore_expiry_validation: nil, ignore_newline_validation: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias

Creates an alias from a key/certificate pair. The structure of the request is controlled by the format query parameter: - keycertfile - Separate PEM- encoded key and certificate files are uploaded. Set Content-Type: multipart/ form-data and include the keyFile, certFile, and password (if keys are encrypted) fields in the request body. If uploading to a truststore, omit keyFile. - pkcs12 - A PKCS12 file is uploaded. Set Content-Type: multipart/ form-data, provide the file in the file field, and include the password field if the file is encrypted in the request body. - selfsignedcert - A new private key and certificate are generated. Set Content-Type: application/json and include CertificateGenerationSpec in the request body.

Parameters:

  • parent (String) —

    Required. Name of the keystore. Use the following format in your request: organizations/org/environments/env/keystores/keystore``.

  • google_api_http_body_object (Google::Apis::ApigeeV1::GoogleApiHttpBody) (defaults to: nil)
  • _password (String) (defaults to: nil) —

    DEPRECATED: For improved security, specify the password in the request body instead of using the query parameter. To specify the password in the request body, set Content-type: multipart/form-data part with name password. Password for the private key file, if required.

  • alias_ (String) (defaults to: nil) —

    Alias for the key/certificate pair. Values must match the regular expression [ \w\s-.]1,255`. This must be provided for all formats exceptselfsignedcert`; self-signed certs may specify the alias in either this parameter or the JSON body.

  • format (String) (defaults to: nil) —

    Required. Format of the data. Valid values include: selfsignedcert, keycertfile, or pkcs12

  • ignore_expiry_validation (Boolean) (defaults to: nil) —

    Flag that specifies whether to ignore expiry validation. If set to true, no expiry validation will be performed.

  • ignore_newline_validation (Boolean) (defaults to: nil) —

    Flag that specifies whether to ignore newline validation. If set to true, no error is thrown when the file contains a certificate chain with no newline between each certificate. Defaults to false.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5009

def create_organization_environment_keystore_alias(parent, google_api_http_body_object = nil, _password: nil, alias_: nil, format: nil, ignore_expiry_validation: nil, ignore_newline_validation: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/aliases', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation
  command.request_object = google_api_http_body_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias
  command.params['parent'] = parent unless parent.nil?
  command.query['_password'] = _password unless _password.nil?
  command.query['alias'] = alias_ unless alias_.nil?
  command.query['format'] = format unless format.nil?
  command.query['ignoreExpiryValidation'] = ignore_expiry_validation unless ignore_expiry_validation.nil?
  command.query['ignoreNewlineValidation'] = ignore_newline_validation unless ignore_newline_validation.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_environment_keyvaluemap(parent, google_cloud_apigee_v1_key_value_map_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap

Creates a key value map in an environment.

Parameters:

  • parent (String) —

    Required. The name of the environment in which to create the key value map. Must be of the form organizations/organization/environments/environment``.

  • google_cloud_apigee_v1_key_value_map_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5216

def create_organization_environment_keyvaluemap(parent, google_cloud_apigee_v1_key_value_map_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/keyvaluemaps', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap::Representation
  command.request_object = google_cloud_apigee_v1_key_value_map_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_environment_query(parent, google_cloud_apigee_v1_query_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery

Submit a query to be processed in the background. If the submission of the query succeeds, the API returns a 201 status and an ID that refer to the query. In addition to the HTTP status 201, the state of "enqueued" means that the request succeeded.

Parameters:

  • parent (String) —

    Required. The parent resource name. Must be of the form organizations/org/ environments/env``.

  • google_cloud_apigee_v1_query_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1Query) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5378

def create_organization_environment_query(parent, google_cloud_apigee_v1_query_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/queries', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Query::Representation
  command.request_object = google_cloud_apigee_v1_query_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_environment_reference(parent, google_cloud_apigee_v1_reference_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference

Creates a Reference in the specified environment.

Parameters:

  • parent (String) —

    Required. The parent environment name under which the Reference will be created. Must be of the form organizations/org/environments/env``.

  • google_cloud_apigee_v1_reference_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5532

def create_organization_environment_reference(parent, google_cloud_apigee_v1_reference_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/references', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference::Representation
  command.request_object = google_cloud_apigee_v1_reference_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_environment_resourcefile(parent, google_api_http_body_object = nil, name: nil, type: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile

Creates a resource file. Specify the Content-Type as application/octet- stream or multipart/form-data. For more information about resource files, see Resource files.

Parameters:

  • parent (String) —

    Required. Name of the environment in which to create the resource file in the following format: organizations/org/environments/env``.

  • google_api_http_body_object (Google::Apis::ApigeeV1::GoogleApiHttpBody) (defaults to: nil)
  • name (String) (defaults to: nil) —

    Required. Name of the resource file. Must match the regular expression: [a-zA- Z0-9:/\!@#$%^&`\[\]()+\-=,.~' ]1,255

  • type (String) (defaults to: nil) —

    Required. Resource file type. resource_file_type

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5673

def create_organization_environment_resourcefile(parent, google_api_http_body_object = nil, name: nil, type: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/resourcefiles', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation
  command.request_object = google_api_http_body_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile
  command.params['parent'] = parent unless parent.nil?
  command.query['name'] = name unless name.nil?
  command.query['type'] = type unless type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_environment_targetserver(parent, google_cloud_apigee_v1_target_server_object = nil, name: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer

Creates a TargetServer in the specified environment.

Parameters:

  • parent (String) —

    Required. The parent environment name under which the TargetServer will be created. Must be of the form organizations/org/environments/env``.

  • google_cloud_apigee_v1_target_server_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer) (defaults to: nil)
  • name (String) (defaults to: nil) —

    Optional. The ID to give the TargetServer. This will overwrite the value in TargetServer.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6152

def create_organization_environment_targetserver(parent, google_cloud_apigee_v1_target_server_object = nil, name: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/targetservers', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer::Representation
  command.request_object = google_cloud_apigee_v1_target_server_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer
  command.params['parent'] = parent unless parent.nil?
  command.query['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_environment_trace_config_override(parent, google_cloud_apigee_v1_trace_config_override_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1TraceConfigOverride

Creates a trace configuration override. The response contains a system- generated UUID, that can be used to view, update, or delete the configuration override. Use the List API to view the existing trace configuration overrides.

Parameters:

  • parent (String) —

    Required. Parent resource of the trace configuration override. Use the following structure in your request. "organizations//environments// traceConfig".

  • google_cloud_apigee_v1_trace_config_override_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1TraceConfigOverride) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6289

def create_organization_environment_trace_config_override(parent, google_cloud_apigee_v1_trace_config_override_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/overrides', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TraceConfigOverride::Representation
  command.request_object = google_cloud_apigee_v1_trace_config_override_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TraceConfigOverride::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TraceConfigOverride
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_host_query(parent, google_cloud_apigee_v1_query_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery

Submit a query at host level to be processed in the background. If the submission of the query succeeds, the API returns a 201 status and an ID that refer to the query. In addition to the HTTP status 201, the state of " enqueued" means that the request succeeded.

Parameters:

  • parent (String) —

    Required. The parent resource name. Must be of the form organizations/org``.

  • google_cloud_apigee_v1_query_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1Query) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6471

def create_organization_host_query(parent, google_cloud_apigee_v1_query_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/hostQueries', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Query::Representation
  command.request_object = google_cloud_apigee_v1_query_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_instance(parent, google_cloud_apigee_v1_instance_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleLongrunningOperation

Creates an Apigee runtime instance. The instance is accessible from the authorized network configured on the organization. Note: Not supported for Apigee hybrid.

Parameters:

  • parent (String) —

    Required. Name of the organization. Use the following structure in your request: organizations/org``.

  • google_cloud_apigee_v1_instance_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1Instance) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6749

def create_organization_instance(parent, google_cloud_apigee_v1_instance_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/instances', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Instance::Representation
  command.request_object = google_cloud_apigee_v1_instance_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_instance_attachment(parent, google_cloud_apigee_v1_instance_attachment_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleLongrunningOperation

Creates a new attachment of an environment to an instance. Note: Not supported for Apigee hybrid.

Parameters:

  • parent (String) —

    Required. Name of the instance. Use the following structure in your request: organizations/org/instances/instance``.

  • google_cloud_apigee_v1_instance_attachment_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1InstanceAttachment) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6922

def create_organization_instance_attachment(parent, google_cloud_apigee_v1_instance_attachment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/attachments', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1InstanceAttachment::Representation
  command.request_object = google_cloud_apigee_v1_instance_attachment_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_instance_canaryevaluation(parent, google_cloud_apigee_v1_canary_evaluation_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleLongrunningOperation

Creates a new canary evaluation for an organization.

Parameters:

  • parent (String) —

    Required. Name of the organization. Use the following structure in your request: organizations/org/instances/instance``.

  • google_cloud_apigee_v1_canary_evaluation_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1CanaryEvaluation) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7057

def create_organization_instance_canaryevaluation(parent, google_cloud_apigee_v1_canary_evaluation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/canaryevaluations', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CanaryEvaluation::Representation
  command.request_object = google_cloud_apigee_v1_canary_evaluation_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_instance_nat_address(parent, google_cloud_apigee_v1_nat_address_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleLongrunningOperation

Creates a NAT address. The address is created in the RESERVED state and a static external IP address will be provisioned. At this time, the instance will not use this IP address for Internet egress traffic. The address can be activated for use once any required firewall IP whitelisting has been completed. Note: Not supported for Apigee hybrid.

Parameters:

  • parent (String) —

    Required. Name of the instance. Use the following structure in your request: organizations/org/instances/instance``

  • google_cloud_apigee_v1_nat_address_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1NatAddress) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7161

def create_organization_instance_nat_address(parent, google_cloud_apigee_v1_nat_address_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/natAddresses', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1NatAddress::Representation
  command.request_object = google_cloud_apigee_v1_nat_address_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_keyvaluemap(parent, google_cloud_apigee_v1_key_value_map_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap

Creates a key value map in an organization.

Parameters:

  • parent (String) —

    Required. The name of the organization in which to create the key value map file. Must be of the form organizations/organization``.

  • google_cloud_apigee_v1_key_value_map_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7297

def create_organization_keyvaluemap(parent, google_cloud_apigee_v1_key_value_map_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/keyvaluemaps', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap::Representation
  command.request_object = google_cloud_apigee_v1_key_value_map_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_report(parent, google_cloud_apigee_v1_custom_report_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport

Creates a Custom Report for an Organization. A Custom Report provides Apigee Customers to create custom dashboards in addition to the standard dashboards which are provided. The Custom Report in its simplest form contains specifications about metrics, dimensions and filters. It is important to note that the custom report by itself does not provide an executable entity. The Edge UI converts the custom report definition into an analytics query and displays the result in a chart.

Parameters:

  • parent (String) —

    Required. The parent organization name under which the Custom Report will be created. Must be of the form: organizations/organization_id/reports

  • google_cloud_apigee_v1_custom_report_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7529

def create_organization_report(parent, google_cloud_apigee_v1_custom_report_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/reports', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport::Representation
  command.request_object = google_cloud_apigee_v1_custom_report_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_sharedflow(parent, google_api_http_body_object = nil, action: nil, name: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision

Uploads a ZIP-formatted shared flow configuration bundle to an organization. If the shared flow already exists, this creates a new revision of it. If the shared flow does not exist, this creates it. Once imported, the shared flow revision must be deployed before it can be accessed at runtime. The size limit of a shared flow bundle is 15 MB.

Parameters:

  • parent (String) —

    Required. The name of the parent organization under which to create the shared flow. Must be of the form: organizations/organization_id``

  • google_api_http_body_object (Google::Apis::ApigeeV1::GoogleApiHttpBody) (defaults to: nil)
  • action (String) (defaults to: nil) —

    Required. Must be set to either import or validate.

  • name (String) (defaults to: nil) —

    Required. The name to give the shared flow

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7701

def create_organization_sharedflow(parent, google_api_http_body_object = nil, action: nil, name: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/sharedflows', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation
  command.request_object = google_api_http_body_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision
  command.params['parent'] = parent unless parent.nil?
  command.query['action'] = action unless action.nil?
  command.query['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_site_apicategory(parent, google_cloud_apigee_v1_api_category_data_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategory

Creates a new category on the portal.

Parameters:

  • parent (String) —

    Required. Name of the portal. Use the following structure in your request: organizations/org/sites/site``

  • google_cloud_apigee_v1_api_category_data_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategoryData) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8018

def create_organization_site_apicategory(parent, google_cloud_apigee_v1_api_category_data_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/apicategories', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategoryData::Representation
  command.request_object = google_cloud_apigee_v1_api_category_data_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategory::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategory
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#csr_organization_environment_keystore_alias(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleApiHttpBody

Generates a PKCS #10 Certificate Signing Request for the private key in an alias.

Parameters:

  • name (String) —

    Required. Name of the alias. Use the following format in your request: organizations/org/environments/env/keystores/keystore/aliases/alias``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5048
5049
5050
5051
5052
5053
5054
5055
5056
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5048

def csr_organization_environment_keystore_alias(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/csr', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleApiHttpBody
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleLongrunningOperation

Delete an Apigee organization. Only supported for SubscriptionType TRIAL.

Parameters:

  • name (String) —

    Required. Name of the organization. Use the following structure in your request: organizations/org``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



144
145
146
147
148
149
150
151
152
 
# File 'lib/google/apis/apigee_v1/service.rb', line 144

def delete_organization(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_analytic_datastore(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleProtobufEmpty

Delete a Datastore from an org.

Parameters:

  • name (String) —

    Required. Resource name of the Datastore to be deleted. Must be of the form organizations/org/analytics/datastores/datastoreId``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



494
495
496
497
498
499
500
501
502
 
# File 'lib/google/apis/apigee_v1/service.rb', line 494

def delete_organization_analytic_datastore(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_api(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy

Deletes an API proxy and all associated endpoints, policies, resources, and revisions. The API proxy must be undeployed before you can delete it.

Parameters:

  • name (String) —

    Required. Name of the API proxy in the following format: organizations/org/ apis/api``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1310
1311
1312
1313
1314
1315
1316
1317
1318
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1310

def delete_organization_api(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_api_keyvaluemap(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap

Delete a key value map in an api proxy.

Parameters:

  • name (String) —

    Required. The name of the key value map. Must be of the form organizations/ organization/apis/api/keyvaluemaps/keyvaluemap``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1475
1476
1477
1478
1479
1480
1481
1482
1483
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1475

def delete_organization_api_keyvaluemap(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_api_revision(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision

Deletes an API proxy revision and all policies, resources, endpoints, and revisions associated with it. The API proxy revision must be undeployed before you can delete it.

Parameters:

  • name (String) —

    Required. API proxy revision in the following format: organizations/org/ apis/api/revisions/rev``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1508
1509
1510
1511
1512
1513
1514
1515
1516
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1508

def delete_organization_api_revision(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_apiproduct(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct

Deletes an API product from an organization. Deleting an API product causes app requests to the resource URIs defined in the API product to fail. Ensure that you create a new API product to serve existing apps, unless your intention is to disable access to the resources defined in the 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.

Parameters:

  • name (String) —

    Required. Name of the API product. Use the following structure in your request: organizations/org/apiproducts/apiproduct``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



759
760
761
762
763
764
765
766
767
 
# File 'lib/google/apis/apigee_v1/service.rb', line 759

def delete_organization_apiproduct(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_apiproduct_attribute(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute

Deletes an API product attribute.

Parameters:

  • name (String) —

    Required. Name of the API product attribute. Use the following structure in your request: organizations/org/apiproducts/apiproduct/attributes/ attribute``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



920
921
922
923
924
925
926
927
928
 
# File 'lib/google/apis/apigee_v1/service.rb', line 920

def delete_organization_apiproduct_attribute(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_apiproduct_rateplan(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan

Deletes a rate plan.

Parameters:

  • name (String) —

    Required. ID of the rate plan. Use the following structure in your request: organizations/org/apiproducts/apiproduct/rateplans/rateplan``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1096
1097
1098
1099
1100
1101
1102
1103
1104
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1096

def delete_organization_apiproduct_rateplan(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_datacollector(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleProtobufEmpty

Deletes a data collector.

Parameters:

  • name (String) —

    Required. Name of the data collector in the following format: organizations/ org/datacollectors/data_collector_id``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1785
1786
1787
1788
1789
1790
1791
1792
1793
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1785

def delete_organization_datacollector(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_developer(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer

Deletes a developer. All apps and API keys associated with the developer are also removed. Warning: This API will permanently delete the developer and related artifacts. To avoid permanently deleting developers and their artifacts, set the developer status to inactive using the SetDeveloperStatus API. Note: The delete operation is asynchronous. The developer app is deleted immediately, but its associated resources, such as apps and API keys, may take anywhere from a few seconds to a few minutes to be deleted.

Parameters:

  • name (String) —

    Required. Email address of the developer. Use the following structure in your request: organizations/org/developers/developer_email``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2043
2044
2045
2046
2047
2048
2049
2050
2051
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2043

def delete_organization_developer(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_developer_app(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp

Deletes a developer app. Note: The delete operation is asynchronous. The developer app is deleted immediately, but its associated resources, such as app keys or access tokens, may take anywhere from a few seconds to a few minutes to be deleted.

Parameters:

  • name (String) —

    Required. Name of the developer app. Use the following structure in your request: organizations/org/developers/developer_email/apps/app``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2333
2334
2335
2336
2337
2338
2339
2340
2341
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2333

def delete_organization_developer_app(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_developer_app_attribute(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute

Deletes a developer app attribute.

Parameters:

  • name (String) —

    Required. Name of the developer app attribute. Use the following structure in your request: organizations/org/developers/developer_email/apps/app/ attributes/attribute``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2562
2563
2564
2565
2566
2567
2568
2569
2570
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2562

def delete_organization_developer_app_attribute(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_developer_app_key(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey

Deletes an app's consumer key and removes all API products associated with the app. After the consumer key is deleted, it cannot be used to access any APIs. * Note*: After you delete a consumer key, you may want to: 1. Create a new consumer key and secret for the developer app using the CreateDeveloperAppKey API, and subsequently add an API product to the key using the UpdateDeveloperAppKey API. 2. Delete the developer app, if it is no longer required.

Parameters:

  • name (String) —

    Name of the developer app key. Use the following structure in your request: organizations/org/developers/developer_email/apps/app/keys/key``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2746
2747
2748
2749
2750
2751
2752
2753
2754
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2746

def delete_organization_developer_app_key(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_developer_app_key_apiproduct(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey

Removes an API product from an app's consumer key. After the API product is removed, the app cannot access the API resources defined in that API product. * Note*: The consumer key is not removed, only its association with the API product.

Parameters:

  • name (String) —

    Name of the API product in the developer app key in the following format: organizations/org/developers/developer_email/apps/app/keys/key/ apiproducts/apiproduct``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2894
2895
2896
2897
2898
2899
2900
2901
2902
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2894

def delete_organization_developer_app_key_apiproduct(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_developer_attribute(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute

Deletes a developer attribute.

Parameters:

  • name (String) —

    Required. Name of the developer attribute. Use the following structure in your request: organizations/org/developers/developer_email/attributes/ attribute``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3010
3011
3012
3013
3014
3015
3016
3017
3018
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3010

def delete_organization_developer_attribute(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_envgroup(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleLongrunningOperation

Deletes an environment group.

Parameters:

  • name (String) —

    Required. Name of the environment group in the following format: organizations/org/envgroups/envgroup``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3327
3328
3329
3330
3331
3332
3333
3334
3335
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3327

def delete_organization_envgroup(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_envgroup_attachment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleLongrunningOperation

Deletes an environment group attachment.

Parameters:

  • name (String) —

    Required. Name of the environment group attachment to delete in the following format: organizations/org/envgroups/envgroup/attachments/attachment``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3498
3499
3500
3501
3502
3503
3504
3505
3506
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3498

def delete_organization_envgroup_attachment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_environment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleLongrunningOperation

Deletes an environment from an organization.

Parameters:

  • name (String) —

    Required. Name of the environment. Use the following structure in your request: organizations/org/environments/env``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3637
3638
3639
3640
3641
3642
3643
3644
3645
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3637

def delete_organization_environment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_environment_api_revision_debugsession_data(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleProtobufEmpty

Deletes the data from a debug session. This does not cancel the debug session or prevent further data from being collected if the session is still active in runtime pods.

Parameters:

  • name (String) —

    Required. The name of the debug session to delete. Must be of the form: organizations/organization/environments/environment/apis/api/revisions/ revision/debugsessions/debugsession``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4490
4491
4492
4493
4494
4495
4496
4497
4498
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4490

def delete_organization_environment_api_revision_debugsession_data(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}/data', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_environment_cach(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleProtobufEmpty

Deletes a cache.

Parameters:

  • name (String) —

    Required. Cache resource name of the form: organizations/organization_id/ environments/environment_id/caches/cache_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4711
4712
4713
4714
4715
4716
4717
4718
4719
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4711

def delete_organization_environment_cach(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_environment_keystore(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore

Deletes a keystore or truststore.

Parameters:

  • name (String) —

    Required. Name of the keystore. Use the following format in your request: organizations/org/environments/env/keystores/keystore``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4917
4918
4919
4920
4921
4922
4923
4924
4925
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4917

def delete_organization_environment_keystore(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_environment_keystore_alias(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias

Deletes an alias.

Parameters:

  • name (String) —

    Required. Name of the alias. Use the following format in your request: organizations/org/environments/env/keystores/keystore/aliases/alias``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5079
5080
5081
5082
5083
5084
5085
5086
5087
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5079

def delete_organization_environment_keystore_alias(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_environment_keyvaluemap(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap

Delete a key value map in an environment.

Parameters:

  • name (String) —

    Required. The name of the key value map. Must be of the form organizations/ organization/environments/environment/keyvaluemaps/keyvaluemap``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5249
5250
5251
5252
5253
5254
5255
5256
5257
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5249

def delete_organization_environment_keyvaluemap(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_environment_reference(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference

Deletes a Reference from an environment. Returns the deleted Reference resource.

Parameters:

  • name (String) —

    Required. The name of the Reference to delete. Must be of the form organizations/org/environments/env/references/ref``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5566
5567
5568
5569
5570
5571
5572
5573
5574
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5566

def delete_organization_environment_reference(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_environment_resourcefile(parent, type, name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile

Deletes a resource file. For more information about resource files, see Resource files.

Parameters:

  • parent (String) —

    Required. Name of the environment in the following format: organizations/org /environments/env``.

  • type (String) —

    Required. Resource file type. resource_file_type

  • name (String) —

    Required. ID of the resource file to delete. Must match the regular expression: [a-zA-Z0-9:/\!@#$%^&`\[\]()+\-=,.~' ]1,255

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5715

def delete_organization_environment_resourcefile(parent, type, name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+parent}/resourcefiles/{type}/{name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile
  command.params['parent'] = parent unless parent.nil?
  command.params['type'] = type unless type.nil?
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_environment_targetserver(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer

Deletes a TargetServer from an environment. Returns the deleted TargetServer resource.

Parameters:

  • name (String) —

    Required. The name of the TargetServer to delete. Must be of the form organizations/org/environments/env/targetservers/target_server_id``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6187
6188
6189
6190
6191
6192
6193
6194
6195
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6187

def delete_organization_environment_targetserver(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_environment_trace_config_override(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleProtobufEmpty

Deletes a distributed trace configuration override.

Parameters:

  • name (String) —

    Required. Name of the trace configuration override. Use the following structure in your request: "organizations//environments//traceConfig/ overrides/*".

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6323
6324
6325
6326
6327
6328
6329
6330
6331
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6323

def delete_organization_environment_trace_config_override(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_instance(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleLongrunningOperation

Deletes an Apigee runtime instance. The instance stops serving requests and the runtime data is deleted. Note: Not supported for Apigee hybrid.

Parameters:

  • name (String) —

    Required. Name of the instance. Use the following structure in your request: organizations/org/instances/instance``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6783
6784
6785
6786
6787
6788
6789
6790
6791
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6783

def delete_organization_instance(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_instance_attachment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleLongrunningOperation

Deletes an attachment. Note: Not supported for Apigee hybrid.

Parameters:

  • name (String) —

    Required. Name of the attachment. Use the following structure in your request: organizations/org/instances/instance/attachments/attachment``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6955
6956
6957
6958
6959
6960
6961
6962
6963
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6955

def delete_organization_instance_attachment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_instance_nat_address(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleLongrunningOperation

Deletes the NAT address. Connections that are actively using the address are drained before it is removed. Note: Not supported for Apigee hybrid.

Parameters:

  • name (String) —

    Required. Name of the nat address. Use the following structure in your request: organizations/org/instances/instances/natAddresses/nataddress```

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7195
7196
7197
7198
7199
7200
7201
7202
7203
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7195

def delete_organization_instance_nat_address(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_keyvaluemap(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap

Delete a key value map in an organization.

Parameters:

  • name (String) —

    Required. The name of the key value map. Must be of the form organizations/ organization/keyvaluemaps/keyvaluemap``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7330
7331
7332
7333
7334
7335
7336
7337
7338
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7330

def delete_organization_keyvaluemap(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_report(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeleteCustomReportResponse

Deletes an existing custom report definition

Parameters:

  • name (String) —

    Required. Custom Report name of the form: organizations/organization_id/ reports/report_name``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7562
7563
7564
7565
7566
7567
7568
7569
7570
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7562

def delete_organization_report(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeleteCustomReportResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeleteCustomReportResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_sharedflow(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlow

Deletes a shared flow and all it's revisions. The shared flow must be undeployed before you can delete it.

Parameters:

  • name (String) —

    Required. shared flow name of the form: organizations/organization_id/ sharedflows/shared_flow_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7737
7738
7739
7740
7741
7742
7743
7744
7745
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7737

def delete_organization_sharedflow(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlow::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlow
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_sharedflow_revision(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision

Deletes a shared flow and all associated policies, resources, and revisions. You must undeploy the shared flow before deleting it.

Parameters:

  • name (String) —

    Required. The name of the shared flow revision to delete. Must be of the form: organizations/organization_id/sharedflows/shared_flow_id/revisions/ revision_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7869
7870
7871
7872
7873
7874
7875
7876
7877
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7869

def delete_organization_sharedflow_revision(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_site_apicategory(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiResponseWrapper

Deletes a category from the portal.

Parameters:

  • name (String) —

    Required. Name of the category. Use the following structure in your request: organizations/org/sites/site/apicategories/apicategory``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



8051
8052
8053
8054
8055
8056
8057
8058
8059
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8051

def delete_organization_site_apicategory(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiResponseWrapper::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiResponseWrapper
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#deploy_organization_environment_api_revision(name, override: nil, sequenced_rollout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment

Deploys a revision of an API proxy. If another revision of the same API proxy revision is currently deployed, set the override parameter to true to have this revision replace the currently deployed revision. You cannot invoke an API proxy until it has been deployed to an environment. After you deploy an API proxy revision, you cannot edit it. To edit the API proxy, you must create and deploy a new revision. For a request path organizations/org/ environments/env/apis/api/revisions/rev/deployments, two permissions are required: * apigee.deployments.create on the resource organizations/ org/environments/env* `apigee.proxyrevisions.deploy` on the resource ` organizations/`org`/apis/`api`/revisions/`rev

Parameters:

  • name (String) —

    Required. Name of the API proxy revision deployment in the following format: organizations/org/environments/env/apis/api/revisions/rev``

  • override (Boolean) (defaults to: nil) —

    Flag that specifies whether the new deployment replaces other deployed revisions of the API proxy in the environment. Set override to true to replace other deployed revisions. By default, override is false and the deployment is rejected if other revisions of the API proxy are deployed in the environment.

  • sequenced_rollout (Boolean) (defaults to: nil) —

    Flag that specifies whether to enable sequenced rollout. If set to true, a best-effort attempt will be made to roll out the routing rules corresponding to this deployment and the environment changes to add this deployment in a safe order. This reduces the risk of downtime that could be caused by changing the environment group's routing before the new destination for the affected traffic is ready to receive it. This should only be necessary if the new deployment will be capturing traffic from another environment under a shared environment group or if traffic will be rerouted to a different environment due to a base path removal. The GenerateDeployChangeReport API may be used to examine routing changes before issuing the deployment request, and its response will indicate if a sequenced rollout is recommended for the deployment.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4335

def deploy_organization_environment_api_revision(name, override: nil, sequenced_rollout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}/deployments', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment
  command.params['name'] = name unless name.nil?
  command.query['override'] = override unless override.nil?
  command.query['sequencedRollout'] = sequenced_rollout unless sequenced_rollout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#deploy_organization_environment_sharedflow_revision(name, override: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment

Deploys a revision of a shared flow. If another revision of the same shared flow is currently deployed, set the override parameter to true to have this revision replace the currently deployed revision. You cannot use a shared flow until it has been deployed to an environment. For a request path organizations/org/environments/env/sharedflows/sf/revisions/rev/ deployments, two permissions are required: * apigee.deployments.create on the resource organizations/org/environments/env* `apigee. sharedflowrevisions.deploy` on the resource `organizations/`org`/sharedflows/` sf`/revisions/`rev

Parameters:

  • name (String) —

    Required. Name of the shared flow revision to deploy in the following format: organizations/org/environments/env/sharedflows/sharedflow/revisions/rev

  • override (Boolean) (defaults to: nil) —

    Flag that specifies whether the new deployment replaces other deployed revisions of the shared flow in the environment. Set override to true to replace other deployed revisions. By default, override is false and the deployment is rejected if other revisions of the shared flow are deployed in the environment.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5950

def deploy_organization_environment_sharedflow_revision(name, override: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}/deployments', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment
  command.params['name'] = name unless name.nil?
  command.query['override'] = override unless override.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#detach_organization_environment_flowhook_shared_flow_from_flow_hook(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook

Detaches a shared flow from a flow hook.

Parameters:

  • name (String) —

    Required. Name of the flow hook to detach in the following format: organizations/org/environments/env/flowhooks/flowhook``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4813
4814
4815
4816
4817
4818
4819
4820
4821
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4813

def detach_organization_environment_flowhook_shared_flow_from_flow_hook(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#expire_organization_developer_subscription(name, google_cloud_apigee_v1_expire_developer_subscription_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperSubscription

Expires an API product subscription immediately.

Parameters:

  • name (String) —

    Required. Name of the API product subscription. Use the following structure in your request: organizations/org/developers/developer_email/subscriptions/ subscription``

  • google_cloud_apigee_v1_expire_developer_subscription_request_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3182

def expire_organization_developer_subscription(name, google_cloud_apigee_v1_expire_developer_subscription_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:expire', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest::Representation
  command.request_object = google_cloud_apigee_v1_expire_developer_subscription_request_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperSubscription::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperSubscription
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#generate_organization_developer_app_key_pair_or_update_developer_app_status(name, google_cloud_apigee_v1_developer_app_object = nil, action: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp

Manages access to a developer app by enabling you to: * Approve or revoke a developer app * Generate a new consumer key and secret for a developer app To approve or revoke a developer app, set the action query parameter to approved or revoked, respectively, and the Content-Type header to application/octet-stream. If a developer app is revoked, none of its API keys are valid for API calls even though the keys are still approved. If successful, the API call returns the following HTTP status code: 204 No Content To generate a new consumer key and secret for a developer app, pass the new key/secret details. Rather than replace an existing key, this API generates a new key. In this case, multiple key pairs may be associated with a single developer app. Each key pair has an independent status (approved or revoked) and expiration time. Any approved, non-expired key can be used in an API call. For example, if you're using API key rotation, you can generate new keys with expiration times that overlap keys that are going to expire. You might also generate a new consumer key/secret if the security of the original key/secret is compromised. The keyExpiresIn property defines the expiration time for the API key in milliseconds. If you don't set this property or set it to -1, the API key never expires. Notes: * When generating a new key/ secret, this API replaces the existing attributes, notes, and callback URLs with those specified in the request. Include or exclude any existing information that you want to retain or delete, respectively. * To migrate existing consumer keys and secrets to hybrid from another system, see the CreateDeveloperAppKey API.

Parameters:

  • name (String) —

    Required. Name of the developer app. Use the following structure in your request: organizations/org/developers/developer_email/apps/app``

  • google_cloud_apigee_v1_developer_app_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp) (defaults to: nil)
  • action (String) (defaults to: nil) —

    Action. Valid values are approve or revoke.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2389

def generate_organization_developer_app_key_pair_or_update_developer_app_status(name, google_cloud_apigee_v1_developer_app_object = nil, action: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp::Representation
  command.request_object = google_cloud_apigee_v1_developer_app_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp
  command.params['name'] = name unless name.nil?
  command.query['action'] = action unless action.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#generate_organization_environment_api_revision_deployment_deploy_change_report(name, override: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeploymentChangeReport

Generates a report for a dry run analysis of a DeployApiProxy request without committing the deployment. In addition to the standard validations performed when adding deployments, additional analysis will be done to detect possible traffic routing changes that would result from this deployment being created. Any potential routing conflicts or unsafe changes will be reported in the response. This routing analysis is not performed for a non-dry-run DeployApiProxy request. For a request path organizations/org/environments/ env/apis/api/revisions/rev/deployments:generateDeployChangeReport, two permissions are required: * apigee.deployments.create on the resource organizations/org/environments/env* `apigee.proxyrevisions.deploy` on the resource `organizations/`org`/apis/`api`/revisions/`rev

Parameters:

  • name (String) —

    Name of the API proxy revision deployment in the following format: organizations/org/environments/env/apis/api/revisions/rev``

  • override (Boolean) (defaults to: nil) —

    Flag that specifies whether to force the deployment of the new revision over the currently deployed revision by overriding conflict checks.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4637

def generate_organization_environment_api_revision_deployment_deploy_change_report(name, override: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}/deployments:generateDeployChangeReport', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeploymentChangeReport::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeploymentChangeReport
  command.params['name'] = name unless name.nil?
  command.query['override'] = override unless override.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#generate_organization_environment_api_revision_deployment_undeploy_change_report(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeploymentChangeReport

Generates a report for a dry run analysis of an UndeployApiProxy request without committing the undeploy. In addition to the standard validations performed when removing deployments, additional analysis will be done to detect possible traffic routing changes that would result from this deployment being removed. Any potential routing conflicts or unsafe changes will be reported in the response. This routing analysis is not performed for a non-dry- run UndeployApiProxy request. For a request path organizations/org/ environments/env/apis/api/revisions/rev/deployments: generateUndeployChangeReport, two permissions are required: * apigee. deployments.delete on the resource organizations/org/environments/env* `apigee.proxyrevisions.undeploy` on the resource `organizations/`org`/apis/` api`/revisions/`rev

Parameters:

  • name (String) —

    Name of the API proxy revision deployment in the following format: organizations/org/environments/env/apis/api/revisions/rev``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4680
4681
4682
4683
4684
4685
4686
4687
4688
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4680

def generate_organization_environment_api_revision_deployment_undeploy_change_report(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}/deployments:generateUndeployChangeReport', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeploymentChangeReport::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeploymentChangeReport
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization

Gets the profile for an Apigee organization. See Understanding organizations.

Parameters:

  • name (String) —

    Required. Apigee organization name in the following format: organizations/ org``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



177
178
179
180
181
182
183
184
185
 
# File 'lib/google/apis/apigee_v1/service.rb', line 177

def get_organization(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_analytic_datastore(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore

Get a Datastore

Parameters:

  • name (String) —

    Required. Resource name of the Datastore to be get. Must be of the form organizations/org/analytics/datastores/datastoreId``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



525
526
527
528
529
530
531
532
533
 
# File 'lib/google/apis/apigee_v1/service.rb', line 525

def get_organization_analytic_datastore(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_api(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy

Gets an API proxy including a list of existing revisions.

Parameters:

  • name (String) —

    Required. Name of the API proxy in the following format: organizations/org/ apis/api``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1341
1342
1343
1344
1345
1346
1347
1348
1349
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1341

def get_organization_api(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_api_revision(name, format: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleApiHttpBody

Gets an API proxy revision. To download the API proxy configuration bundle for the specified revision as a zip file, set the format query parameter to bundle. If you are using curl, specify -o filename.zip to save the output to a file; otherwise, it displays to stdout. Then, develop the API proxy configuration locally and upload the updated API proxy configuration revision, as described in updateApiProxyRevision.

Parameters:

  • name (String) —

    Required. API proxy revision in the following format: organizations/org/ apis/api/revisions/rev``

  • format (String) (defaults to: nil) —

    Format used when downloading the API proxy configuration revision. Set to bundle to download the API proxy configuration revision as a zip file.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1547

def get_organization_api_revision(name, format: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleApiHttpBody
  command.params['name'] = name unless name.nil?
  command.query['format'] = format unless format.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_apiproduct(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct

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.

Parameters:

  • name (String) —

    Required. Name of the API product. Use the following structure in your request: organizations/org/apiproducts/apiproduct``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



794
795
796
797
798
799
800
801
802
 
# File 'lib/google/apis/apigee_v1/service.rb', line 794

def get_organization_apiproduct(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_apiproduct_attribute(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute

Gets the value of an API product attribute.

Parameters:

  • name (String) —

    Required. Name of the API product attribute. Use the following structure in your request: organizations/org/apiproducts/apiproduct/attributes/ attribute``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



952
953
954
955
956
957
958
959
960
 
# File 'lib/google/apis/apigee_v1/service.rb', line 952

def get_organization_apiproduct_attribute(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_apiproduct_rateplan(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan

Gets the details of a rate plan.

Parameters:

  • name (String) —

    Required. Name of the rate plan. Use the following structure in your request: organizations/org/apiproducts/apiproduct/rateplans/rateplan``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1127
1128
1129
1130
1131
1132
1133
1134
1135
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1127

def get_organization_apiproduct_rateplan(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_app(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1App

Gets the app profile for the specified app ID.

Parameters:

  • name (String) —

    Required. App ID in the following format: organizations/org/apps/app``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1653
1654
1655
1656
1657
1658
1659
1660
1661
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1653

def get_organization_app(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1App::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1App
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_datacollector(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataCollector

Gets a data collector.

Parameters:

  • name (String) —

    Required. Name of the data collector in the following format: organizations/ org/datacollectors/data_collector_id``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1816
1817
1818
1819
1820
1821
1822
1823
1824
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1816

def get_organization_datacollector(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataCollector::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataCollector
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_deployed_ingress_config(name, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1IngressConfig

Gets the deployed ingress configuration for an organization.

Parameters:

  • name (String) —

    Required. Name of the deployed configuration for the organization in the following format: 'organizations/org/deployedIngressConfig'.

  • view (String) (defaults to: nil) —

    When set to FULL, additional details about the specific deployments receiving traffic will be included in the IngressConfig response's RoutingRules.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



211
212
213
214
215
216
217
218
219
220
 
# File 'lib/google/apis/apigee_v1/service.rb', line 211

def get_organization_deployed_ingress_config(name, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1IngressConfig::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1IngressConfig
  command.params['name'] = name unless name.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_developer(name, action: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer

Returns the developer details, including the developer's name, email address, apps, and other information. Note: The response includes only the first 100 developer apps.

Parameters:

  • name (String) —

    Required. Email address of the developer. Use the following structure in your request: organizations/org/developers/developer_email``

  • action (String) (defaults to: nil) —

    Status of the developer. Valid values are active or inactive.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2078

def get_organization_developer(name, action: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer
  command.params['name'] = name unless name.nil?
  command.query['action'] = action unless action.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_developer_app(name, entity: nil, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp

Returns the details for a developer app.

Parameters:

  • name (String) —

    Required. Name of the developer app. Use the following structure in your request: organizations/org/developers/developer_email/apps/app``

  • entity (String) (defaults to: nil) —

    Note: Must be used in conjunction with the query parameter. Set to apiresources to return the number of API resources that have been approved for access by a developer app in the specified Apigee organization.

  • query (String) (defaults to: nil) —

    Note: Must be used in conjunction with the entity parameter. Set to count to return the number of API resources that have been approved for access by a developer app in the specified Apigee organization.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2431

def get_organization_developer_app(name, entity: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp
  command.params['name'] = name unless name.nil?
  command.query['entity'] = entity unless entity.nil?
  command.query['query'] = query unless query.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_developer_app_attribute(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute

Returns a developer app attribute.

Parameters:

  • name (String) —

    Required. Name of the developer app attribute. Use the following structure in your request: organizations/org/developers/developer_email/apps/app/ attributes/attribute``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2594
2595
2596
2597
2598
2599
2600
2601
2602
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2594

def get_organization_developer_app_attribute(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_developer_app_key(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey

Gets details for a consumer key for a developer app, including the key and secret value, associated API products, and other information.

Parameters:

  • name (String) —

    Name of the developer app key. Use the following structure in your request: organizations/org/developers/developer_email/apps/app/keys/key``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2778
2779
2780
2781
2782
2783
2784
2785
2786
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2778

def get_organization_developer_app_key(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_developer_attribute(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute

Returns the value of the specified developer attribute.

Parameters:

  • name (String) —

    Required. Name of the developer attribute. Use the following structure in your request: organizations/org/developers/developer_email/attributes/ attribute``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3042
3043
3044
3045
3046
3047
3048
3049
3050
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3042

def get_organization_developer_attribute(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_developer_subscription(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperSubscription

Gets details for an API product subscription.

Parameters:

  • name (String) —

    Required. Name of the API product subscription. Use the following structure in your request: organizations/org/developers/developer_email/subscriptions/ subscription``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3216
3217
3218
3219
3220
3221
3222
3223
3224
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3216

def get_organization_developer_subscription(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperSubscription::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperSubscription
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_envgroup(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentGroup

Gets an environment group.

Parameters:

  • name (String) —

    Required. Name of the environment group in the following format: organizations/org/envgroups/envgroup``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3358
3359
3360
3361
3362
3363
3364
3365
3366
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3358

def get_organization_envgroup(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentGroup::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentGroup
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_envgroup_attachment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentGroupAttachment

Gets an environment group attachment.

Parameters:

  • name (String) —

    Required. Name of the environment group attachment in the following format: organizations/org/envgroups/envgroup/attachments/attachment``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3529
3530
3531
3532
3533
3534
3535
3536
3537
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3529

def get_organization_envgroup_attachment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentGroupAttachment::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentGroupAttachment
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_environment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment

Gets environment details.

Parameters:

  • name (String) —

    Required. Name of the environment. Use the following structure in your request: organizations/org/environments/env``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3668
3669
3670
3671
3672
3673
3674
3675
3676
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3668

def get_organization_environment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_environment_analytic_admin_schemav2(name, disable_cache: nil, type: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Schema

Gets a list of metrics and dimensions that can be used to create analytics queries and reports. Each schema element contains the name of the field, its associated type, and a flag indicating whether it is a standard or custom field.

Parameters:

  • name (String) —

    Required. Path to the schema. Use the following structure in your request: organizations/org/environments/env/analytics/admin/schemav2.

  • disable_cache (Boolean) (defaults to: nil) —

    Flag that specifies whether the schema is be read from the database or cache. Set to true to read the schema from the database. Defaults to cache.

  • type (String) (defaults to: nil) —

    Required. Name of the dataset for which you want to retrieve the schema. For example: fact or agg_cus1

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4142

def get_organization_environment_analytic_admin_schemav2(name, disable_cache: nil, type: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Schema::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Schema
  command.params['name'] = name unless name.nil?
  command.query['disableCache'] = disable_cache unless disable_cache.nil?
  command.query['type'] = type unless type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_environment_analytic_export(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Export

Gets the details and status of an analytics export job. If the export job is still in progress, its state is set to "running". After the export job has completed successfully, its state is set to "completed". If the export job fails, its state is set to failed.

Parameters:

  • name (String) —

    Required. Resource name of the export to get.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4213
4214
4215
4216
4217
4218
4219
4220
4221
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4213

def get_organization_environment_analytic_export(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Export::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Export
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_environment_api_revision_debugsession(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSession

Retrieves a debug session.

Parameters:

  • name (String) —

    Required. The name of the debug session to retrieve. Must be of the form: organizations/organization/environments/environment/apis/api/revisions/ revision/debugsessions/session``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4522
4523
4524
4525
4526
4527
4528
4529
4530
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4522

def get_organization_environment_api_revision_debugsession(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSession::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSession
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_environment_api_revision_debugsession_datum(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSessionTransaction

Gets the debug data from a transaction.

Parameters:

  • name (String) —

    Required. The name of the debug session transaction. Must be of the form: organizations/organization/environments/environment/apis/api/revisions/ revision/debugsessions/session/data/transaction``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4593
4594
4595
4596
4597
4598
4599
4600
4601
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4593

def get_organization_environment_api_revision_debugsession_datum(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSessionTransaction::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSessionTransaction
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_environment_api_revision_deployments(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment

Gets the deployment of an API proxy revision and actual state reported by runtime pods.

Parameters:

  • name (String) —

    Required. Name representing an API proxy revision in an environment in the following format: organizations/org/environments/env/apis/api/revisions/ rev``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4370
4371
4372
4373
4374
4375
4376
4377
4378
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4370

def get_organization_environment_api_revision_deployments(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/deployments', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_environment_debugmask(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask

Gets the debug mask singleton resource for an environment.

Parameters:

  • name (String) —

    Required. Name of the debug mask. Use the following structure in your request: organizations/org/environments/env/debugmask.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3699
3700
3701
3702
3703
3704
3705
3706
3707
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3699

def get_organization_environment_debugmask(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_environment_deployed_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentConfig

Gets the deployed configuration for an environment.

Parameters:

  • name (String) —

    Required. Name of the environment deployed configuration resource. Use the following structure in your request: organizations/org/environments/env/ deployedConfig

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3731
3732
3733
3734
3735
3736
3737
3738
3739
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3731

def get_organization_environment_deployed_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentConfig::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentConfig
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_environment_flowhook(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook

Returns the name of the shared flow attached to the specified flow hook. If there's no shared flow attached to the flow hook, the API does not return an error; it simply does not return a name in the response.

Parameters:

  • name (String) —

    Required. Name of the flow hook in the following format: organizations/org/ environments/env/flowhooks/flowhook``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4846
4847
4848
4849
4850
4851
4852
4853
4854
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4846

def get_organization_environment_flowhook(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_environment_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleIamV1Policy

Gets the IAM policy on an environment. For more information, see Manage users, roles, and permissions using the API. You must have the apigee.environments.getIamPolicy permission to call this API.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

  • options_requested_policy_version (Fixnum) (defaults to: nil) —

    Optional. The policy format version to be returned. Valid values are 0, 1, and

    1. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation.
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3773

def get_organization_environment_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleIamV1Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_environment_keystore(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore

Gets a keystore or truststore.

Parameters:

  • name (String) —

    Required. Name of the keystore. Use the following format in your request: organizations/org/environments/env/keystores/keystore``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4948
4949
4950
4951
4952
4953
4954
4955
4956
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4948

def get_organization_environment_keystore(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_environment_keystore_alias(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias

Gets an alias.

Parameters:

  • name (String) —

    Required. Name of the alias. Use the following format in your request: organizations/org/environments/env/keystores/keystore/aliases/alias``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5110
5111
5112
5113
5114
5115
5116
5117
5118
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5110

def get_organization_environment_keystore_alias(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_environment_keystore_alias_certificate(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleApiHttpBody

Gets the certificate from an alias in PEM-encoded form.

Parameters:

  • name (String) —

    Required. Name of the alias. Use the following format in your request: organizations/org/environments/env/keystores/keystore/aliases/alias``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5141
5142
5143
5144
5145
5146
5147
5148
5149
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5141

def get_organization_environment_keystore_alias_certificate(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/certificate', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleApiHttpBody
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_environment_optimized_stat(name, accuracy: nil, agg_table: nil, filter: nil, limit: nil, offset: nil, realtime: nil, select: nil, sonar: nil, sort: nil, sortby: nil, time_range: nil, time_unit: nil, topk: nil, ts_ascending: nil, tzo: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1OptimizedStats

This api is similar to GetStats except that the response is less verbose. In the current scheme, a query parameter _optimized instructs Edge Analytics to change the response but since this behavior is not possible with protocol buffer and since this parameter is predominantly used by Edge UI, we are introducing a separate api.

Parameters:

  • name (String) —

    Required. The resource name for which the interactive query will be executed. Must be of the form organizations/organization_id/environments/ environment_id/optimizedStats/dimensionsDimensions let you view metrics in meaningful groupings. E.g. apiproxy, target_host. The value of dimensions should be comma separated list as shown beloworganizations/org/ environments/env/optimizedStats/apiproxy,request_verb`

  • accuracy (String) (defaults to: nil) —

    Legacy field: not used anymore.

  • agg_table (String) (defaults to: nil) —

    If customers want to query custom aggregate tables, then this parameter can be used to specify the table name. If this parameter is skipped, then Edge Query will try to retrieve the data from fact tables which will be expensive.

  • filter (String) (defaults to: nil) —

    Enables drill-down on specific dimension values.

  • limit (String) (defaults to: nil) —

    This parameter is used to limit the number of result items. Default and the max value is 14400.

  • offset (String) (defaults to: nil) —

    Use offset with limit to enable pagination of results. For example, to display results 11-20, set limit to '10' and offset to '10'.

  • realtime (Boolean) (defaults to: nil) —

    Legacy field: not used anymore.

  • select (String) (defaults to: nil) —

    Required. The select parameter contains a comma separated list of metrics. E.g. sum(message_count),sum(error_count)

  • sonar (Boolean) (defaults to: nil) —

    This parameter routes the query to api monitoring service for last hour.

  • sort (String) (defaults to: nil) —

    This parameter specifies if the sort order should be ascending or descending Supported values are DESC and ASC.

  • sortby (String) (defaults to: nil) —

    Comma separated list of columns to sort the final result.

  • time_range (String) (defaults to: nil) —

    Required. Time interval for the interactive query. Time range is specified as start~end E.g. 04/15/2017 00:00~05/15/2017 23:59

  • time_unit (String) (defaults to: nil) —

    A value of second, minute, hour, day, week, month. Time Unit specifies the granularity of metrics returned.

  • topk (String) (defaults to: nil) —

    Take 'top k' results from results, for example, to return the top 5 results ' topk=5'.

  • ts_ascending (Boolean) (defaults to: nil) —

    Lists timestamps in ascending order if set to true. Recommend setting this value to true if you are using sortby with sort=DESC.

  • tzo (String) (defaults to: nil) —

    This parameters contains the timezone offset value.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5328

def get_organization_environment_optimized_stat(name, accuracy: nil, agg_table: nil, filter: nil, limit: nil, offset: nil, realtime: nil, select: nil, sonar: nil, sort: nil, sortby: nil, time_range: nil, time_unit: nil, topk: nil, ts_ascending: nil, tzo: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1OptimizedStats::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1OptimizedStats
  command.params['name'] = name unless name.nil?
  command.query['accuracy'] = accuracy unless accuracy.nil?
  command.query['aggTable'] = agg_table unless agg_table.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['limit'] = limit unless limit.nil?
  command.query['offset'] = offset unless offset.nil?
  command.query['realtime'] = realtime unless realtime.nil?
  command.query['select'] = select unless select.nil?
  command.query['sonar'] = sonar unless sonar.nil?
  command.query['sort'] = sort unless sort.nil?
  command.query['sortby'] = sortby unless sortby.nil?
  command.query['timeRange'] = time_range unless time_range.nil?
  command.query['timeUnit'] = time_unit unless time_unit.nil?
  command.query['topk'] = topk unless topk.nil?
  command.query['tsAscending'] = ts_ascending unless ts_ascending.nil?
  command.query['tzo'] = tzo unless tzo.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_environment_query(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery

Get query status If the query is still in progress, the state is set to " running" After the query has completed successfully, state is set to " completed"

Parameters:

  • name (String) —

    Required. Name of the asynchronous query to get. Must be of the form organizations/org/environments/env/queries/queryId``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5413
5414
5415
5416
5417
5418
5419
5420
5421
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5413

def get_organization_environment_query(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_environment_query_result(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleApiHttpBody

After the query is completed, use this API to retrieve the results. If the request succeeds, and there is a non-zero result set, the result is downloaded to the client as a zipped JSON file. The name of the downloaded file will be: OfflineQueryResult-.zip Example: OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f- 318d0cb961bd.zip

Parameters:

  • name (String) —

    Required. Name of the asynchronous query result to get. Must be of the form organizations/org/environments/env/queries/queryId/result.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5448
5449
5450
5451
5452
5453
5454
5455
5456
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5448

def get_organization_environment_query_result(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleApiHttpBody
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_environment_reference(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference

Gets a Reference resource.

Parameters:

  • name (String) —

    Required. The name of the Reference to get. Must be of the form organizations/ org/environments/env/references/ref``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5597
5598
5599
5600
5601
5602
5603
5604
5605
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5597

def get_organization_environment_reference(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_environment_resourcefile(parent, type, name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleApiHttpBody

Gets the contents of a resource file. For more information about resource files, see Resource files.

Parameters:

  • parent (String) —

    Required. Name of the environment in the following format: organizations/org /environments/env``.

  • type (String) —

    Required. Resource file type. resource_file_type

  • name (String) —

    Required. ID of the resource file. Must match the regular expression: [a-zA-Z0- 9:/\!@#$%^&`\[\]()+\-=,.~' ]1,255

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5755

def get_organization_environment_resourcefile(parent, type, name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/resourcefiles/{type}/{name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleApiHttpBody
  command.params['parent'] = parent unless parent.nil?
  command.params['type'] = type unless type.nil?
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_environment_sharedflow_revision_deployments(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment

Gets the deployment of a shared flow revision and actual state reported by runtime pods.

Parameters:

  • name (String) —

    Required. Name representing a shared flow in an environment in the following format: organizations/org/environments/env/sharedflows/sharedflow/ revisions/rev``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5984
5985
5986
5987
5988
5989
5990
5991
5992
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5984

def get_organization_environment_sharedflow_revision_deployments(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/deployments', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_environment_stat(name, accuracy: nil, agg_table: nil, filter: nil, limit: nil, offset: nil, realtime: nil, select: nil, sonar: nil, sort: nil, sortby: nil, time_range: nil, time_unit: nil, topk: nil, ts_ascending: nil, tzo: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Stats

Retrieve metrics grouped by dimensions. The types of metrics you can retrieve include traffic, message counts, API call latency, response size, and cache hits and counts. Dimensions let you view metrics in meaningful groups. The stats api does accept dimensions as path params. The dimensions are optional in which case the metrics are computed on the entire data for the given timerange.

Parameters:

  • name (String) —

    Required. The resource name for which the interactive query will be executed. Must be of the form organizations/organization_id/environments/ environment_id/stats/dimensionsDimensions let you view metrics in meaningful groupings. E.g. apiproxy, target_host. The value of dimensions should be comma separated list as shown beloworganizations/org/ environments/env/stats/apiproxy,request_verb`

  • accuracy (String) (defaults to: nil) —

    Legacy field: not used anymore. This field is present to support UI calls which still use this parameter.

  • agg_table (String) (defaults to: nil) —

    If customers want to query custom aggregate tables, then this parameter can be used to specify the table name. If this parameter is skipped, then Edge Query will try to retrieve the data from fact tables which will be expensive.

  • filter (String) (defaults to: nil) —

    Enables drill-down on specific dimension values

  • limit (String) (defaults to: nil) —

    This parameter is used to limit the number of result items. Default and the max value is 14400.

  • offset (String) (defaults to: nil) —

    Use offset with limit to enable pagination of results. For example, to display results 11-20, set limit to '10' and offset to '10'.

  • realtime (Boolean) (defaults to: nil) —

    Legacy field: not used anymore.

  • select (String) (defaults to: nil) —

    The select parameter contains a comma separated list of metrics. E.g. sum( message_count),sum(error_count)

  • sonar (Boolean) (defaults to: nil) —

    This parameter routes the query to api monitoring service for last hour.

  • sort (String) (defaults to: nil) —

    This parameter specifies if the sort order should be ascending or descending Supported values are DESC and ASC.

  • sortby (String) (defaults to: nil) —

    Comma separated list of columns to sort the final result.

  • time_range (String) (defaults to: nil) —

    Time interval for the interactive query. Time range is specified as start~end E.g. 04/15/2017 00:00~05/15/2017 23:59

  • time_unit (String) (defaults to: nil) —

    A value of second, minute, hour, day, week, month. Time Unit specifies the granularity of metrics returned.

  • topk (String) (defaults to: nil) —

    Take 'top k' results from results, for example, to return the top 5 results ' topk=5'.

  • ts_ascending (Boolean) (defaults to: nil) —

    Lists timestamps in ascending order if set to true. Recommend setting this value to true if you are using sortby with sort=DESC.

  • tzo (String) (defaults to: nil) —

    This parameters contains the timezone offset value.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6102

def get_organization_environment_stat(name, accuracy: nil, agg_table: nil, filter: nil, limit: nil, offset: nil, realtime: nil, select: nil, sonar: nil, sort: nil, sortby: nil, time_range: nil, time_unit: nil, topk: nil, ts_ascending: nil, tzo: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Stats::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Stats
  command.params['name'] = name unless name.nil?
  command.query['accuracy'] = accuracy unless accuracy.nil?
  command.query['aggTable'] = agg_table unless agg_table.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['limit'] = limit unless limit.nil?
  command.query['offset'] = offset unless offset.nil?
  command.query['realtime'] = realtime unless realtime.nil?
  command.query['select'] = select unless select.nil?
  command.query['sonar'] = sonar unless sonar.nil?
  command.query['sort'] = sort unless sort.nil?
  command.query['sortby'] = sortby unless sortby.nil?
  command.query['timeRange'] = time_range unless time_range.nil?
  command.query['timeUnit'] = time_unit unless time_unit.nil?
  command.query['topk'] = topk unless topk.nil?
  command.query['tsAscending'] = ts_ascending unless ts_ascending.nil?
  command.query['tzo'] = tzo unless tzo.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_environment_targetserver(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer

Gets a TargetServer resource.

Parameters:

  • name (String) —

    Required. The name of the TargetServer to get. Must be of the form organizations/org/environments/env/targetservers/target_server_id``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6218
6219
6220
6221
6222
6223
6224
6225
6226
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6218

def get_organization_environment_targetserver(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_environment_trace_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1TraceConfig

Get distributed trace configuration in an environment.

Parameters:

  • name (String) —

    Required. Name of the trace configuration. Use the following structure in your request: "organizations//environments//traceConfig".

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3805
3806
3807
3808
3809
3810
3811
3812
3813
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3805

def get_organization_environment_trace_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TraceConfig::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TraceConfig
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_environment_trace_config_override(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1TraceConfigOverride

Gets a trace configuration override.

Parameters:

  • name (String) —

    Required. Name of the trace configuration override. Use the following structure in your request: "organizations//environments//traceConfig/ overrides/*".

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6355
6356
6357
6358
6359
6360
6361
6362
6363
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6355

def get_organization_environment_trace_config_override(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TraceConfigOverride::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TraceConfigOverride
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_host_query(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery

Get status of a query submitted at host level. If the query is still in progress, the state is set to "running" After the query has completed successfully, state is set to "completed"

Parameters:

  • name (String) —

    Required. Name of the asynchronous query to get. Must be of the form organizations/org/queries/queryId``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6506
6507
6508
6509
6510
6511
6512
6513
6514
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6506

def get_organization_host_query(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_host_query_result(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleApiHttpBody

After the query is completed, use this API to retrieve the results. If the request succeeds, and there is a non-zero result set, the result is downloaded to the client as a zipped JSON file. The name of the downloaded file will be: OfflineQueryResult-.zip Example: OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f- 318d0cb961bd.zip

Parameters:

  • name (String) —

    Required. Name of the asynchronous query result to get. Must be of the form organizations/org/queries/queryId/result.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6541
6542
6543
6544
6545
6546
6547
6548
6549
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6541

def get_organization_host_query_result(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleApiHttpBody
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_host_query_result_view(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQueryResultView

Parameters:

  • name (String) —

    Required. Name of the asynchronous query result view to get. Must be of the form organizations/org/queries/queryId/resultView.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6572
6573
6574
6575
6576
6577
6578
6579
6580
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6572

def get_organization_host_query_result_view(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQueryResultView::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQueryResultView
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_host_stat(name, accuracy: nil, envgroup_hostname: nil, filter: nil, limit: nil, offset: nil, realtime: nil, select: nil, sort: nil, sortby: nil, time_range: nil, time_unit: nil, topk: nil, ts_ascending: nil, tzo: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Stats

Retrieve metrics grouped by dimensions in host level. The types of metrics you can retrieve include traffic, message counts, API call latency, response size, and cache hits and counts. Dimensions let you view metrics in meaningful groups. The stats api does accept dimensions as path params. The dimensions are optional in which case the metrics are computed on the entire data for the given timerange.

Parameters:

  • name (String) —

    Required. The resource name for which the interactive query will be executed. Must be of the form organizations/organization_id/hostStats/dimensions`. Dimensions let you view metrics in meaningful groupings. E.g. apiproxy, target_host. The value of dimensions should be comma separated list as shown beloworganizations/org/hostStats/apiproxy,request_verb`

  • accuracy (String) (defaults to: nil) —

    Legacy field: not used anymore.

  • envgroup_hostname (String) (defaults to: nil) —

    Required. The hostname for which the interactive query will be executed.

  • filter (String) (defaults to: nil) —

    Enables drill-down on specific dimension values.

  • limit (String) (defaults to: nil) —

    This parameter is used to limit the number of result items. Default and the max value is 14400.

  • offset (String) (defaults to: nil) —

    Use offset with limit to enable pagination of results. For example, to display results 11-20, set limit to '10' and offset to '10'.

  • realtime (Boolean) (defaults to: nil) —

    Legacy field: not used anymore.

  • select (String) (defaults to: nil) —

    The select parameter contains a comma separated list of metrics. E.g. sum( message_count),sum(error_count)

  • sort (String) (defaults to: nil) —

    This parameter specifies if the sort order should be ascending or descending Supported values are DESC and ASC.

  • sortby (String) (defaults to: nil) —

    Comma separated list of columns to sort the final result.

  • time_range (String) (defaults to: nil) —

    Time interval for the interactive query. Time range is specified as start~end E.g. 04/15/2017 00:00~05/15/2017 23:59

  • time_unit (String) (defaults to: nil) —

    A value of second, minute, hour, day, week, month. Time Unit specifies the granularity of metrics returned.

  • topk (String) (defaults to: nil) —

    Take 'top k' results from results, for example, to return the top 5 results ' topk=5'.

  • ts_ascending (Boolean) (defaults to: nil) —

    Lists timestamps in ascending order if set to true. Recommend setting this value to true if you are using sortby with sort=DESC.

  • tzo (String) (defaults to: nil) —

    This parameters contains the timezone offset value.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6701

def get_organization_host_stat(name, accuracy: nil, envgroup_hostname: nil, filter: nil, limit: nil, offset: nil, realtime: nil, select: nil, sort: nil, sortby: nil, time_range: nil, time_unit: nil, topk: nil, ts_ascending: nil, tzo: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Stats::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Stats
  command.params['name'] = name unless name.nil?
  command.query['accuracy'] = accuracy unless accuracy.nil?
  command.query['envgroupHostname'] = envgroup_hostname unless envgroup_hostname.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['limit'] = limit unless limit.nil?
  command.query['offset'] = offset unless offset.nil?
  command.query['realtime'] = realtime unless realtime.nil?
  command.query['select'] = select unless select.nil?
  command.query['sort'] = sort unless sort.nil?
  command.query['sortby'] = sortby unless sortby.nil?
  command.query['timeRange'] = time_range unless time_range.nil?
  command.query['timeUnit'] = time_unit unless time_unit.nil?
  command.query['topk'] = topk unless topk.nil?
  command.query['tsAscending'] = ts_ascending unless ts_ascending.nil?
  command.query['tzo'] = tzo unless tzo.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_instance(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Instance

Gets the details for an Apigee runtime instance. Note: Not supported for Apigee hybrid.

Parameters:

  • name (String) —

    Required. Name of the instance. Use the following structure in your request: organizations/org/instances/instance``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6815
6816
6817
6818
6819
6820
6821
6822
6823
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6815

def get_organization_instance(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Instance::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Instance
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_instance_attachment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1InstanceAttachment

Gets an attachment. Note: Not supported for Apigee hybrid.

Parameters:

  • name (String) —

    Required. Name of the attachment. Use the following structure in your request: organizations/org/instances/instance/attachments/attachment``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6986
6987
6988
6989
6990
6991
6992
6993
6994
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6986

def get_organization_instance_attachment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1InstanceAttachment::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1InstanceAttachment
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_instance_canaryevaluation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1CanaryEvaluation

Gets a CanaryEvaluation for an organization.

Parameters:

  • name (String) —

    Required. Name of the CanaryEvaluation. Use the following structure in your request: organizations/org/instances/*/canaryevaluations/evaluation``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7090
7091
7092
7093
7094
7095
7096
7097
7098
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7090

def get_organization_instance_canaryevaluation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CanaryEvaluation::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CanaryEvaluation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_instance_nat_address(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1NatAddress

Gets the details of a NAT address. Note: Not supported for Apigee hybrid.

Parameters:

  • name (String) —

    Required. Name of the nat address. Use the following structure in your request: organizations/org/instances/instances/natAddresses/nataddress``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7226
7227
7228
7229
7230
7231
7232
7233
7234
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7226

def get_organization_instance_nat_address(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1NatAddress::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1NatAddress
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7361
7362
7363
7364
7365
7366
7367
7368
7369
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7361

def get_organization_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_optimized_host_stat(name, accuracy: nil, envgroup_hostname: nil, filter: nil, limit: nil, offset: nil, realtime: nil, select: nil, sort: nil, sortby: nil, time_range: nil, time_unit: nil, topk: nil, ts_ascending: nil, tzo: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1OptimizedStats

This api is similar to GetHostStats except that the response is less verbose.

Parameters:

  • name (String) —

    Required. The resource name for which the interactive query will be executed. Must be of the form organizations/organization_id/optimizedHostStats/ dimensions`. Dimensions let you view metrics in meaningful groupings. E.g. apiproxy, target_host. The value of dimensions should be comma separated list as shown beloworganizations/org/optimizedHostStats/apiproxy,request_verb`

  • accuracy (String) (defaults to: nil) —

    Legacy field: not used anymore.

  • envgroup_hostname (String) (defaults to: nil) —

    Required. The hostname for which the interactive query will be executed.

  • filter (String) (defaults to: nil) —

    Enables drill-down on specific dimension values.

  • limit (String) (defaults to: nil) —

    This parameter is used to limit the number of result items. Default and the max value is 14400.

  • offset (String) (defaults to: nil) —

    Use offset with limit to enable pagination of results. For example, to display results 11-20, set limit to '10' and offset to '10'.

  • realtime (Boolean) (defaults to: nil) —

    Legacy field: not used anymore.

  • select (String) (defaults to: nil) —

    Required. The select parameter contains a comma separated list of metrics. E.g. sum(message_count),sum(error_count)

  • sort (String) (defaults to: nil) —

    This parameter specifies if the sort order should be ascending or descending Supported values are DESC and ASC.

  • sortby (String) (defaults to: nil) —

    Comma separated list of columns to sort the final result.

  • time_range (String) (defaults to: nil) —

    Required. Time interval for the interactive query. Time range is specified as start~end. E.g 04/15/2017 00:00~05/15/2017 23:59.

  • time_unit (String) (defaults to: nil) —

    A value of second, minute, hour, day, week, month. Time Unit specifies the granularity of metrics returned.

  • topk (String) (defaults to: nil) —

    Take 'top k' results from results, for example, to return the top 5 results ' topk=5'.

  • ts_ascending (Boolean) (defaults to: nil) —

    Lists timestamps in ascending order if set to true. Recommend setting this value to true if you are using sortby with sort=DESC.

  • tzo (String) (defaults to: nil) —

    This parameters contains the timezone offset value.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7477

def get_organization_optimized_host_stat(name, accuracy: nil, envgroup_hostname: nil, filter: nil, limit: nil, offset: nil, realtime: nil, select: nil, sort: nil, sortby: nil, time_range: nil, time_unit: nil, topk: nil, ts_ascending: nil, tzo: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1OptimizedStats::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1OptimizedStats
  command.params['name'] = name unless name.nil?
  command.query['accuracy'] = accuracy unless accuracy.nil?
  command.query['envgroupHostname'] = envgroup_hostname unless envgroup_hostname.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['limit'] = limit unless limit.nil?
  command.query['offset'] = offset unless offset.nil?
  command.query['realtime'] = realtime unless realtime.nil?
  command.query['select'] = select unless select.nil?
  command.query['sort'] = sort unless sort.nil?
  command.query['sortby'] = sortby unless sortby.nil?
  command.query['timeRange'] = time_range unless time_range.nil?
  command.query['timeUnit'] = time_unit unless time_unit.nil?
  command.query['topk'] = topk unless topk.nil?
  command.query['tsAscending'] = ts_ascending unless ts_ascending.nil?
  command.query['tzo'] = tzo unless tzo.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_report(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport

Retrieve a custom report definition.

Parameters:

  • name (String) —

    Required. Custom Report name of the form: organizations/organization_id/ reports/report_name``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7593
7594
7595
7596
7597
7598
7599
7600
7601
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7593

def get_organization_report(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_runtime_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1RuntimeConfig

Get runtime config for an organization.

Parameters:

  • name (String) —

    Required. Name of the runtime config for the organization in the following format: 'organizations/org/runtimeConfig'.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



243
244
245
246
247
248
249
250
251
 
# File 'lib/google/apis/apigee_v1/service.rb', line 243

def get_organization_runtime_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1RuntimeConfig::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1RuntimeConfig
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_sharedflow(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlow

Gets a shared flow by name, including a list of its revisions.

Parameters:

  • name (String) —

    Required. The name of the shared flow to get. Must be of the form: organizations/organization_id/sharedflows/shared_flow_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7768
7769
7770
7771
7772
7773
7774
7775
7776
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7768

def get_organization_sharedflow(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlow::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlow
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_sharedflow_revision(name, format: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleApiHttpBody

Gets a revision of a shared flow. To download the shared flow configuration bundle for the specified revision as a zip file, set the format query parameter to bundle. If you are using curl, specify -o filename.zip to save the output to a file; otherwise, it displays to stdout. Then, develop the shared flow configuration locally and upload the updated sharedFlow configuration revision, as described in updateSharedFlowRevision.

Parameters:

  • name (String) —

    Required. The name of the shared flow revision to get. Must be of the form: organizations/organization_id/sharedflows/shared_flow_id/revisions/ revision_id``

  • format (String) (defaults to: nil) —

    Specify bundle to export the contents of the shared flow bundle. Otherwise, the bundle metadata is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7910

def get_organization_sharedflow_revision(name, format: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleApiHttpBody
  command.params['name'] = name unless name.nil?
  command.query['format'] = format unless format.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_site_apicategory(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategory

Gets a category on the portal.

Parameters:

  • name (String) —

    Required. Name of the category. Use the following structure in your request: organizations/org/sites/site/apicategories/apicategory``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



8082
8083
8084
8085
8086
8087
8088
8089
8090
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8082

def get_organization_site_apicategory(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategory::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategory
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_sync_authorization(name, google_cloud_apigee_v1_get_sync_authorization_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1SyncAuthorization

Lists the service accounts with the permissions required to allow the Synchronizer to download environment data from the control plane. An ETag is returned in the response to getSyncAuthorization. Pass that ETag when calling setSyncAuthorization to ensure that you are updating the correct version. If you don't pass the ETag in the call to setSyncAuthorization, then the existing authorization is overwritten indiscriminately. For more information, see Configure the Synchronizer. Note: Available to Apigee hybrid only.

Parameters:

  • name (String) —

    Required. Name of the Apigee organization. Use the following structure in your request: organizations/org``

  • google_cloud_apigee_v1_get_sync_authorization_request_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1GetSyncAuthorizationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/google/apis/apigee_v1/service.rb', line 283

def get_organization_sync_authorization(name, google_cloud_apigee_v1_get_sync_authorization_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:getSyncAuthorization', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1GetSyncAuthorizationRequest::Representation
  command.request_object = google_cloud_apigee_v1_get_sync_authorization_request_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SyncAuthorization::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SyncAuthorization
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_hybrid_issuers(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListHybridIssuersResponse

Lists hybrid services and its trusted issuers service account ids. This api is authenticated and unauthorized(allow all the users) and used by runtime authn- authz service to query control plane's issuer service account ids.

Parameters:

  • name (String) —

    Required. Must be of the form hybrid/issuers.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



77
78
79
80
81
82
83
84
85
 
# File 'lib/google/apis/apigee_v1/service.rb', line 77

def list_hybrid_issuers(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListHybridIssuersResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListHybridIssuersResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_analytic_datastores(parent, target_type: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDatastoresResponse

List Datastores

Parameters:

  • parent (String) —

    Required. The parent organization name. Must be of the form organizations/ org``.

  • target_type (String) (defaults to: nil) —

    Optional. TargetType is used to fetch all Datastores that match the type

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



558
559
560
561
562
563
564
565
566
567
 
# File 'lib/google/apis/apigee_v1/service.rb', line 558

def list_organization_analytic_datastores(parent, target_type: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/analytics/datastores', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDatastoresResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDatastoresResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['targetType'] = target_type unless target_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_api_deployments(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse

Lists all deployments of an API proxy.

Parameters:

  • parent (String) —

    Required. Name of the API proxy for which to return deployment information in the following format: organizations/org/apis/api``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1410
1411
1412
1413
1414
1415
1416
1417
1418
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1410

def list_organization_api_deployments(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/deployments', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_api_revision_deployments(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse

Lists all deployments of an API proxy revision.

Parameters:

  • parent (String) —

    Required. Name of the API proxy revision for which to return deployment information in the following format: organizations/org/apis/api/revisions/ rev``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1623
1624
1625
1626
1627
1628
1629
1630
1631
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1623

def list_organization_api_revision_deployments(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/deployments', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_apiproduct_attributes(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes

Lists all API product attributes.

Parameters:

  • parent (String) —

    Required. Name of the API product. Use the following structure in your request: organizations/org/apiproducts/apiproduct``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



983
984
985
986
987
988
989
990
991
 
# File 'lib/google/apis/apigee_v1/service.rb', line 983

def list_organization_apiproduct_attributes(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/attributes', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_apiproduct_rateplans(parent, count: nil, expand: nil, order_by: nil, start_key: nil, state: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListRatePlansResponse

Lists all the rate plans for an API product.

Parameters:

  • parent (String) —

    Required. Name of the API product. Use the following structure in your request: organizations/org/apiproducts/apiproduct`Useorganizations/org/ apiproducts/-` to return rate plans for all API products within the organization.

  • count (Fixnum) (defaults to: nil) —

    Number of rate plans to return in the API call. Use with the startKey parameter to provide more targeted filtering. The maximum limit is 1000. Defaults to 100.

  • expand (Boolean) (defaults to: nil) —

    Flag that specifies whether to expand the results. Set to true to get expanded details about each API. Defaults to false.

  • order_by (String) (defaults to: nil) —

    Name of the attribute used for sorting. Valid values include: * name: Name of the rate plan. * state: State of the rate plan (DRAFT, PUBLISHED). * startTime: Time when the rate plan becomes active. * endTime: Time when the rate plan expires. Note: Not supported by Apigee at this time.

  • start_key (String) (defaults to: nil) —

    Name of the rate plan from which to start displaying the list of rate plans. If omitted, the list starts from the first item. For example, to view the rate plans from 51-150, set the value of startKey to the name of the 51st rate plan and set the value of count to 100.

  • state (String) (defaults to: nil) —

    State of the rate plans (DRAFT, PUBLISHED) that you want to display.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1179

def list_organization_apiproduct_rateplans(parent, count: nil, expand: nil, order_by: nil, start_key: nil, state: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/rateplans', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListRatePlansResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListRatePlansResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['count'] = count unless count.nil?
  command.query['expand'] = expand unless expand.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['startKey'] = start_key unless start_key.nil?
  command.query['state'] = state unless state.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_apiproducts(parent, attributename: nil, attributevalue: nil, count: nil, expand: nil, start_key: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiProductsResponse

Lists all API product names for an organization. Filter the list by passing an attributename and attibutevalue. The maximum number of API products returned is 1000. You can paginate the list of API products returned using the startKey and count query parameters.

Parameters:

  • parent (String) —

    Required. Name of the organization. Use the following structure in your request: organizations/org``

  • attributename (String) (defaults to: nil) —

    Name of the attribute used to filter the search.

  • attributevalue (String) (defaults to: nil) —

    Value of the attribute used to filter the search.

  • count (Fixnum) (defaults to: nil) —

    Enter the number of API products you want returned in the API call. The limit is 1000.

  • expand (Boolean) (defaults to: nil) —

    Flag that specifies whether to expand the results. Set to true to get expanded details about each API.

  • start_key (String) (defaults to: nil) —

    Gets a list of API products starting with a specific API product in the list. For example, if you're returning 50 API products at a time (using the count query parameter), you can view products 50-99 by entering the name of the 50th API product in the first API (without using startKey). Product name is case sensitive.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



844
845
846
847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/google/apis/apigee_v1/service.rb', line 844

def list_organization_apiproducts(parent, attributename: nil, attributevalue: nil, count: nil, expand: nil, start_key: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/apiproducts', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiProductsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiProductsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['attributename'] = attributename unless attributename.nil?
  command.query['attributevalue'] = attributevalue unless attributevalue.nil?
  command.query['count'] = count unless count.nil?
  command.query['expand'] = expand unless expand.nil?
  command.query['startKey'] = start_key unless start_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_apis(parent, include_meta_data: nil, include_revisions: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiProxiesResponse

Lists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy.

Parameters:

  • parent (String) —

    Required. Name of the organization in the following format: organizations/ org``

  • include_meta_data (Boolean) (defaults to: nil) —

    Flag that specifies whether to include API proxy metadata in the response.

  • include_revisions (Boolean) (defaults to: nil) —

    Flag that specifies whether to include a list of revisions in the response.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1377

def list_organization_apis(parent, include_meta_data: nil, include_revisions: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/apis', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiProxiesResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiProxiesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['includeMetaData'] = include_meta_data unless include_meta_data.nil?
  command.query['includeRevisions'] = include_revisions unless include_revisions.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_apps(parent, api_product: nil, apptype: nil, expand: nil, ids: nil, include_cred: nil, key_status: nil, rows: nil, start_key: nil, status: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAppsResponse

Lists IDs of apps within an organization that have the specified app status ( approved or revoked) or are of the specified app type (developer or company).

Parameters:

  • parent (String) —

    Required. Resource path of the parent in the following format: organizations/ org``

  • api_product (String) (defaults to: nil) —

    API product.

  • apptype (String) (defaults to: nil) —

    Optional. Filter by the type of the app. Valid values are company or developer. Defaults to developer.

  • expand (Boolean) (defaults to: nil) —

    Optional. Flag that specifies whether to return an expanded list of apps for the organization. Defaults to false.

  • ids (String) (defaults to: nil) —

    Optional. Comma-separated list of app IDs on which to filter.

  • include_cred (Boolean) (defaults to: nil) —

    Optional. Flag that specifies whether to include credentials in the response.

  • key_status (String) (defaults to: nil) —

    Optional. Key status of the app. Valid values include approved or revoked. Defaults to approved.

  • rows (Fixnum) (defaults to: nil) —

    Optional. Maximum number of app IDs to return. Defaults to 10000.

  • start_key (String) (defaults to: nil) —

    Returns the list of apps starting from the specified app ID.

  • status (String) (defaults to: nil) —

    Optional. Filter by the status of the app. Valid values are approved or revoked. Defaults to approved.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1707

def list_organization_apps(parent, api_product: nil, apptype: nil, expand: nil, ids: nil, include_cred: nil, key_status: nil, rows: nil, start_key: nil, status: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/apps', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAppsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAppsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['apiProduct'] = api_product unless api_product.nil?
  command.query['apptype'] = apptype unless apptype.nil?
  command.query['expand'] = expand unless expand.nil?
  command.query['ids'] = ids unless ids.nil?
  command.query['includeCred'] = include_cred unless include_cred.nil?
  command.query['keyStatus'] = key_status unless key_status.nil?
  command.query['rows'] = rows unless rows.nil?
  command.query['startKey'] = start_key unless start_key.nil?
  command.query['status'] = status unless status.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_datacollectors(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDataCollectorsResponse

Lists all data collectors.

Parameters:

  • parent (String) —

    Required. Name of the organization for which to list data collectors in the following format: organizations/org``.

  • page_size (Fixnum) (defaults to: nil) —

    Maximum number of data collectors to return. The page size defaults to 25.

  • page_token (String) (defaults to: nil) —

    Page token, returned from a previous ListDataCollectors call, that you can use to retrieve the next page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1852

def list_organization_datacollectors(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/datacollectors', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDataCollectorsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDataCollectorsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_deployments(parent, shared_flows: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse

Lists all deployments of API proxies or shared flows.

Parameters:

  • parent (String) —

    Required. Name of the organization for which to return deployment information in the following format: organizations/org``

  • shared_flows (Boolean) (defaults to: nil) —

    Optional. Flag that specifies whether to return shared flow or API proxy deployments. Set to true to return shared flow deployments; set to false to return API proxy deployments. Defaults to false.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1926

def list_organization_deployments(parent, shared_flows: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/deployments', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['sharedFlows'] = shared_flows unless shared_flows.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_developer_app_attributes(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes

Returns a list of all developer app attributes.

Parameters:

  • parent (String) —

    Required. Name of the developer app. Use the following structure in your request: organizations/org/developers/developer_email/apps/app``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2625
2626
2627
2628
2629
2630
2631
2632
2633
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2625

def list_organization_developer_app_attributes(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/attributes', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_developer_apps(parent, count: nil, expand: nil, shallow_expand: nil, start_key: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeveloperAppsResponse

Lists all apps created by a developer in an Apigee organization. Optionally, you can request an expanded view of the developer apps. A maximum of 100 developer apps are returned per API call. You can paginate the list of deveoper apps returned using the startKey and count query parameters.

Parameters:

  • parent (String) —

    Required. Name of the developer. Use the following structure in your request: organizations/org/developers/developer_email``

  • count (Fixnum) (defaults to: nil) —

    Number of developer apps to return in the API call. Use with the startKey parameter to provide more targeted filtering. The limit is 1000.

  • expand (Boolean) (defaults to: nil) —

    Optional. Specifies whether to expand the results. Set to true to expand the results. This query parameter is not valid if you use the count or startKey query parameters.

  • shallow_expand (Boolean) (defaults to: nil) —

    Optional. Specifies whether to expand the results in shallow mode. Set to true to expand the results in shallow mode.

  • start_key (String) (defaults to: nil) —

    Note: Must be used in conjunction with the count parameter. Name of the developer app from which to start displaying the list of developer apps. For example, if you're returning 50 developer apps at a time (using the count query parameter), you can view developer apps 50-99 by entering the name of the 50th developer app. The developer app name is case sensitive.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2483

def list_organization_developer_apps(parent, count: nil, expand: nil, shallow_expand: nil, start_key: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/apps', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeveloperAppsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeveloperAppsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['count'] = count unless count.nil?
  command.query['expand'] = expand unless expand.nil?
  command.query['shallowExpand'] = shallow_expand unless shallow_expand.nil?
  command.query['startKey'] = start_key unless start_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_developer_attributes(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes

Returns a list of all developer attributes.

Parameters:

  • parent (String) —

    Required. Email address of the developer for which attributes are being listed. Use the following structure in your request: organizations/org/developers/ developer_email``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3074
3075
3076
3077
3078
3079
3080
3081
3082
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3074

def list_organization_developer_attributes(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/attributes', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_developer_subscriptions(parent, count: nil, start_key: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse

Lists all API product subscriptions for a developer.

Parameters:

  • parent (String) —

    Required. Email address of the developer. Use the following structure in your request: organizations/org/developers/developer_email``

  • count (Fixnum) (defaults to: nil) —

    Number of API product subscriptions to return in the API call. Use with startKey to provide more targeted filtering. Defaults to 100. The maximum limit is 1000.

  • start_key (String) (defaults to: nil) —

    Name of the API product subscription from which to start displaying the list of subscriptions. If omitted, the list starts from the first item. For example, to view the API product subscriptions from 51-150, set the value of startKey to the name of the 51st subscription and set the value of count to 100.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3256

def list_organization_developer_subscriptions(parent, count: nil, start_key: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/subscriptions', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['count'] = count unless count.nil?
  command.query['startKey'] = start_key unless start_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_developers(parent, app: nil, count: nil, expand: nil, ids: nil, include_company: nil, start_key: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListOfDevelopersResponse

Lists all developers in an organization by email address. By default, the response does not include company developers. Set the includeCompany query parameter to true to include company developers. Note: A maximum of 1000 developers are returned in the response. You paginate the list of developers returned using the startKey and count query parameters.

Parameters:

  • parent (String) —

    Required. Name of the Apigee organization. Use the following structure in your request: organizations/org``.

  • app (String) (defaults to: nil) —

    Optional. List only Developers that are associated with the app. Note that start_key, count are not applicable for this filter criteria.

  • count (Fixnum) (defaults to: nil) —

    Optional. Number of developers to return in the API call. Use with the startKey parameter to provide more targeted filtering. The limit is 1000.

  • expand (Boolean) (defaults to: nil) —

    Specifies whether to expand the results. Set to true to expand the results. This query parameter is not valid if you use the count or startKey query parameters.

  • ids (String) (defaults to: nil) —

    Optional. List of IDs to include, separated by commas.

  • include_company (Boolean) (defaults to: nil) —

    Flag that specifies whether to include company details in the response.

  • start_key (String) (defaults to: nil) —

    Note: Must be used in conjunction with the count parameter. Email address of the developer from which to start displaying the list of developers. For example, if the an unfiltered list returns: westley@example.com fezzik@example.com buttercup@example.com and your startKey is fezzik@ example.com, the list returned will be fezzik@example.com buttercup@ example.com

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2135

def list_organization_developers(parent, app: nil, count: nil, expand: nil, ids: nil, include_company: nil, start_key: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/developers', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListOfDevelopersResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListOfDevelopersResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['app'] = app unless app.nil?
  command.query['count'] = count unless count.nil?
  command.query['expand'] = expand unless expand.nil?
  command.query['ids'] = ids unless ids.nil?
  command.query['includeCompany'] = include_company unless include_company.nil?
  command.query['startKey'] = start_key unless start_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_envgroup_attachments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse

Lists all attachments of an environment group.

Parameters:

  • parent (String) —

    Required. Name of the environment group in the following format: organizations/org/envgroups/envgroup``.

  • page_size (Fixnum) (defaults to: nil) —

    Maximum number of environment group attachments to return. The page size defaults to 25.

  • page_token (String) (defaults to: nil) —

    Page token, returned by a previous ListEnvironmentGroupAttachments call, that you can use to retrieve the next page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3566

def list_organization_envgroup_attachments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/attachments', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_envgroups(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentGroupsResponse

Lists all environment groups.

Parameters:

  • parent (String) —

    Required. Name of the organization for which to list environment groups in the following format: organizations/org``.

  • page_size (Fixnum) (defaults to: nil) —

    Maximum number of environment groups to return. The page size defaults to 25.

  • page_token (String) (defaults to: nil) —

    Page token, returned from a previous ListEnvironmentGroups call, that you can use to retrieve the next page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3394

def list_organization_envgroups(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/envgroups', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentGroupsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentGroupsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_environment_analytic_exports(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListExportsResponse

Lists the details and status of all analytics export jobs belonging to the parent organization and environment.

Parameters:

  • parent (String) —

    Required. Names of the parent organization and environment. Must be of the form organizations/org/environments/env``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4245
4246
4247
4248
4249
4250
4251
4252
4253
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4245

def list_organization_environment_analytic_exports(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/analytics/exports', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListExportsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListExportsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_environment_api_deployments(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse

Lists all deployments of an API proxy in an environment.

Parameters:

  • parent (String) —

    Required. Name representing an API proxy in an environment in the following format: organizations/org/environments/env/apis/api``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4276
4277
4278
4279
4280
4281
4282
4283
4284
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4276

def list_organization_environment_api_deployments(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/deployments', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_environment_api_revision_debugsessions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDebugSessionsResponse

Lists debug sessions that are currently active in the given API Proxy revision.

Parameters:

  • parent (String) —

    Required. The name of the API Proxy revision deployment for which to list debug sessions. Must be of the form: organizations/organization/ environments/environment/apis/api/revisions/revision``.

  • page_size (Fixnum) (defaults to: nil) —

    Maximum number of debug sessions to return. The page size defaults to 25.

  • page_token (String) (defaults to: nil) —

    Page token, returned from a previous ListDebugSessions call, that you can use to retrieve the next page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4559

def list_organization_environment_api_revision_debugsessions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/debugsessions', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDebugSessionsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDebugSessionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_environment_deployments(parent, shared_flows: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse

Lists all deployments of API proxies or shared flows in an environment.

Parameters:

  • parent (String) —

    Required. Name of the environment for which to return deployment information in the following format: organizations/org/environments/env``

  • shared_flows (Boolean) (defaults to: nil) —

    Optional. Flag that specifies whether to return shared flow or API proxy deployments. Set to true to return shared flow deployments; set to false to return API proxy deployments. Defaults to false.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4746

def list_organization_environment_deployments(parent, shared_flows: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/deployments', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['sharedFlows'] = shared_flows unless shared_flows.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_environment_queries(parent, dataset: nil, from: nil, incl_queries_without_report: nil, status: nil, submitted_by: nil, to: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAsyncQueriesResponse

Return a list of Asynchronous Queries

Parameters:

  • parent (String) —

    Required. The parent resource name. Must be of the form organizations/org/ environments/env``.

  • dataset (String) (defaults to: nil) —

    Filter response list by dataset. Example: api, mint

  • from (String) (defaults to: nil) —

    Filter response list by returning asynchronous queries that created after this date time. Time must be in ISO date-time format like '2011-12-03T10:15:30Z'.

  • incl_queries_without_report (String) (defaults to: nil) —

    Flag to include asynchronous queries that don't have a report denifition.

  • status (String) (defaults to: nil) —

    Filter response list by asynchronous query status.

  • submitted_by (String) (defaults to: nil) —

    Filter response list by user who submitted queries.

  • to (String) (defaults to: nil) —

    Filter response list by returning asynchronous queries that created before this date time. Time must be in ISO date-time format like '2011-12-03T10:16: 30Z'.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5494

def list_organization_environment_queries(parent, dataset: nil, from: nil, incl_queries_without_report: nil, status: nil, submitted_by: nil, to: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/queries', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAsyncQueriesResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAsyncQueriesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['dataset'] = dataset unless dataset.nil?
  command.query['from'] = from unless from.nil?
  command.query['inclQueriesWithoutReport'] = incl_queries_without_report unless incl_queries_without_report.nil?
  command.query['status'] = status unless status.nil?
  command.query['submittedBy'] = submitted_by unless submitted_by.nil?
  command.query['to'] = to unless to.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_environment_resourcefile_environment_resources(parent, type, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentResourcesResponse

Lists all resource files, optionally filtering by type. For more information about resource files, see Resource files.

Parameters:

  • parent (String) —

    Required. Name of the environment in which to list resource files in the following format: organizations/org/environments/env``.

  • type (String) —

    Optional. Type of resource files to list. resource_file_type

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5828

def list_organization_environment_resourcefile_environment_resources(parent, type, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/resourcefiles/{type}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentResourcesResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentResourcesResponse
  command.params['parent'] = parent unless parent.nil?
  command.params['type'] = type unless type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_environment_resourcefiles(parent, type: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentResourcesResponse

Lists all resource files, optionally filtering by type. For more information about resource files, see Resource files.

Parameters:

  • parent (String) —

    Required. Name of the environment in which to list resource files in the following format: organizations/org/environments/env``.

  • type (String) (defaults to: nil) —

    Optional. Type of resource files to list. resource_file_type

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5792

def list_organization_environment_resourcefiles(parent, type: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/resourcefiles', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentResourcesResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentResourcesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['type'] = type unless type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_environment_sharedflow_deployments(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse

Lists all deployments of a shared flow in an environment.

Parameters:

  • parent (String) —

    Required. Name representing a shared flow in an environment in the following format: organizations/org/environments/env/sharedflows/sharedflow``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5904
5905
5906
5907
5908
5909
5910
5911
5912
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5904

def list_organization_environment_sharedflow_deployments(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/deployments', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_environment_trace_config_overrides(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListTraceConfigOverridesResponse

Lists all of the distributed trace configuration overrides in an environment.

Parameters:

  • parent (String) —

    Required. Parent resource of the trace configuration override. Use the following structure in your request: "organizations//environments// traceConfig".

  • page_size (Fixnum) (defaults to: nil) —

    Maximum number of trace configuration overrides to return. If not specified, the maximum number returned is 25. The maximum number cannot exceed 100.

  • page_token (String) (defaults to: nil) —

    A page token, returned from a previous ListTraceConfigOverrides call. Token value that can be used to retrieve the subsequent page. When paginating, all other parameters provided to ListTraceConfigOverrides must match those specified in the call to obtain the page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6395

def list_organization_environment_trace_config_overrides(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/overrides', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListTraceConfigOverridesResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListTraceConfigOverridesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_host_queries(parent, dataset: nil, envgroup_hostname: nil, from: nil, incl_queries_without_report: nil, status: nil, submitted_by: nil, to: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAsyncQueriesResponse

Return a list of Asynchronous Queries at host level.

Parameters:

  • parent (String) —

    Required. The parent resource name. Must be of the form organizations/org``.

  • dataset (String) (defaults to: nil) —

    Filter response list by dataset. Example: api, mint

  • envgroup_hostname (String) (defaults to: nil) —

    Required. Filter response list by hostname.

  • from (String) (defaults to: nil) —

    Filter response list by returning asynchronous queries that created after this date time. Time must be in ISO date-time format like '2011-12-03T10:15:30Z'.

  • incl_queries_without_report (String) (defaults to: nil) —

    Flag to include asynchronous queries that don't have a report denifition.

  • status (String) (defaults to: nil) —

    Filter response list by asynchronous query status.

  • submitted_by (String) (defaults to: nil) —

    Filter response list by user who submitted queries.

  • to (String) (defaults to: nil) —

    Filter response list by returning asynchronous queries that created before this date time. Time must be in ISO date-time format like '2011-12-03T10:16: 30Z'.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6619

def list_organization_host_queries(parent, dataset: nil, envgroup_hostname: nil, from: nil, incl_queries_without_report: nil, status: nil, submitted_by: nil, to: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/hostQueries', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAsyncQueriesResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAsyncQueriesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['dataset'] = dataset unless dataset.nil?
  command.query['envgroupHostname'] = envgroup_hostname unless envgroup_hostname.nil?
  command.query['from'] = from unless from.nil?
  command.query['inclQueriesWithoutReport'] = incl_queries_without_report unless incl_queries_without_report.nil?
  command.query['status'] = status unless status.nil?
  command.query['submittedBy'] = submitted_by unless submitted_by.nil?
  command.query['to'] = to unless to.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_instance_attachments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListInstanceAttachmentsResponse

Lists all attachments to an instance. Note: Not supported for Apigee hybrid.

Parameters:

  • parent (String) —

    Required. Name of the organization. Use the following structure in your request: organizations/org/instances/instance``

  • page_size (Fixnum) (defaults to: nil) —

    Maximum number of instance attachments to return. Defaults to 25.

  • page_token (String) (defaults to: nil) —

    Page token, returned by a previous ListInstanceAttachments call, that you can use to retrieve the next page of content.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7023

def list_organization_instance_attachments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/attachments', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListInstanceAttachmentsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListInstanceAttachmentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_instance_nat_addresses(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListNatAddressesResponse

Lists the NAT addresses for an Apigee instance. Note: Not supported for Apigee hybrid.

Parameters:

  • parent (String) —

    Required. Name of the instance. Use the following structure in your request: organizations/org/instances/instance``

  • page_size (Fixnum) (defaults to: nil) —

    Maximum number of natAddresses to return. Defaults to 25.

  • page_token (String) (defaults to: nil) —

    Page token, returned from a previous ListNatAddresses call, that you can use to retrieve the next page of content.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7263

def list_organization_instance_nat_addresses(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/natAddresses', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListNatAddressesResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListNatAddressesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_instances(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListInstancesResponse

Lists all Apigee runtime instances for the organization. Note: Not supported for Apigee hybrid.

Parameters:

  • parent (String) —

    Required. Name of the organization. Use the following structure in your request: organizations/org``.

  • page_size (Fixnum) (defaults to: nil) —

    Maximum number of instances to return. Defaults to 25.

  • page_token (String) (defaults to: nil) —

    Page token, returned from a previous ListInstances call, that you can use to retrieve the next page of content.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6852

def list_organization_instances(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/instances', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListInstancesResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListInstancesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/name=users/*/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7404

def list_organization_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_reports(parent, expand: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListCustomReportsResponse

Return a list of Custom Reports

Parameters:

  • parent (String) —

    Required. The parent organization name under which the API product will be listed organizations/organization_id/reports

  • expand (Boolean) (defaults to: nil) —

    Set to 'true' to get expanded details about each custom report.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7626

def list_organization_reports(parent, expand: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/reports', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListCustomReportsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListCustomReportsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['expand'] = expand unless expand.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_sharedflow_deployments(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse

Lists all deployments of a shared flow.

Parameters:

  • parent (String) —

    Required. Name of the shared flow for which to return deployment information in the following format: organizations/org/sharedflows/sharedflow``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7836
7837
7838
7839
7840
7841
7842
7843
7844
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7836

def list_organization_sharedflow_deployments(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/deployments', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_sharedflow_revision_deployments(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse

Lists all deployments of a shared flow revision.

Parameters:

  • parent (String) —

    Required. Name of the API proxy revision for which to return deployment information in the following format: organizations/org/sharedflows/ sharedflow/revisions/rev``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7986
7987
7988
7989
7990
7991
7992
7993
7994
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7986

def list_organization_sharedflow_revision_deployments(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/deployments', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_sharedflows(parent, include_meta_data: nil, include_revisions: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListSharedFlowsResponse

Lists all shared flows in the organization.

Parameters:

  • parent (String) —

    Required. The name of the parent organization under which to get shared flows. Must be of the form: organizations/organization_id``

  • include_meta_data (Boolean) (defaults to: nil) —

    Indicates whether to include shared flow metadata in the response.

  • include_revisions (Boolean) (defaults to: nil) —

    Indicates whether to include a list of revisions in the response.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7803

def list_organization_sharedflows(parent, include_meta_data: nil, include_revisions: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/sharedflows', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListSharedFlowsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListSharedFlowsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['includeMetaData'] = include_meta_data unless include_meta_data.nil?
  command.query['includeRevisions'] = include_revisions unless include_revisions.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_site_apicategories(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiCategoriesResponse

Lists the categories on the portal.

Parameters:

  • parent (String) —

    Required. Name of the portal. Use the following structure in your request: organizations/org/sites/site``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



8113
8114
8115
8116
8117
8118
8119
8120
8121
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8113

def list_organization_site_apicategories(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/apicategories', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiCategoriesResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiCategoriesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organizations(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListOrganizationsResponse

Lists the Apigee organizations and associated GCP projects that you have permission to access. See Understanding organizations.

Parameters:

  • parent (String) —

    Required. Use the following structure in your request: organizations

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



317
318
319
320
321
322
323
324
325
 
# File 'lib/google/apis/apigee_v1/service.rb', line 317

def list_organizations(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListOrganizationsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListOrganizationsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_organization_datacollector(name, google_cloud_apigee_v1_data_collector_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataCollector

Updates a data collector.

Parameters:

  • name (String) —

    Required. Name of the data collector in the following format: organizations/ org/datacollectors/data_collector_id``.

  • google_cloud_apigee_v1_data_collector_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataCollector) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    List of fields to be updated.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1888

def patch_organization_datacollector(name, google_cloud_apigee_v1_data_collector_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataCollector::Representation
  command.request_object = google_cloud_apigee_v1_data_collector_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataCollector::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataCollector
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_organization_envgroup(name, google_cloud_apigee_v1_environment_group_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleLongrunningOperation

Updates an environment group.

Parameters:

  • name (String) —

    Required. Name of the environment group to update in the format: organizations/org/envgroups/envgroup`.

  • google_cloud_apigee_v1_environment_group_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentGroup) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    List of fields to be updated.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3430

def patch_organization_envgroup(name, google_cloud_apigee_v1_environment_group_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentGroup::Representation
  command.request_object = google_cloud_apigee_v1_environment_group_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_organization_environment_trace_config_override(name, google_cloud_apigee_v1_trace_config_override_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1TraceConfigOverride

Updates a distributed trace configuration override. Note that the repeated fields have replace semantics when included in the field mask and that they will be overwritten by the value of the fields in the request body.

Parameters:

  • name (String) —

    Required. Name of the trace configuration override. Use the following structure in your request: "organizations//environments//traceConfig/ overrides/*".

  • google_cloud_apigee_v1_trace_config_override_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1TraceConfigOverride) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    List of fields to be updated.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6434

def patch_organization_environment_trace_config_override(name, google_cloud_apigee_v1_trace_config_override_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TraceConfigOverride::Representation
  command.request_object = google_cloud_apigee_v1_trace_config_override_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TraceConfigOverride::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TraceConfigOverride
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_organization_site_apicategory(name, google_cloud_apigee_v1_api_category_data_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategory

Updates a category on the portal.

Parameters:

  • name (String) —

    Required. Name of the category. Use the following structure in your request: organizations/org/sites/site/apicategories/apicategory``

  • google_cloud_apigee_v1_api_category_data_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategoryData) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8145

def patch_organization_site_apicategory(name, google_cloud_apigee_v1_api_category_data_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategoryData::Representation
  command.request_object = google_cloud_apigee_v1_api_category_data_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategory::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategory
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#provision_project_organization(project, google_cloud_apigee_v1_provision_organization_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleLongrunningOperation

Provisions a new Apigee organization with a functioning runtime. This is the standard way to create trial organizations for a free Apigee trial.

Parameters:

  • project (String) —

    Required. Name of the GCP project with which to associate the Apigee organization.

  • google_cloud_apigee_v1_provision_organization_request_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1ProvisionOrganizationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8180

def provision_project_organization(project, google_cloud_apigee_v1_provision_organization_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+project}:provisionOrganization', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ProvisionOrganizationRequest::Representation
  command.request_object = google_cloud_apigee_v1_provision_organization_request_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
  command.params['project'] = project unless project.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#replace_organization_developer_app_key_developer_app_key(name, google_cloud_apigee_v1_developer_app_key_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey

Updates the scope of an app. This API replaces the existing scopes with those specified in the request. Include or exclude any existing scopes that you want to retain or delete, respectively. The specified scopes must already be defined for the API products associated with the app. This API sets the scopes element under the apiProducts element in the attributes of the app.

Parameters:

  • name (String) —

    Name of the developer app key. Use the following structure in your request: organizations/org/developers/developer_email/apps/app/keys/key``

  • google_cloud_apigee_v1_developer_app_key_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2814

def replace_organization_developer_app_key_developer_app_key(name, google_cloud_apigee_v1_developer_app_key_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation
  command.request_object = google_cloud_apigee_v1_developer_app_key_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#report_organization_instance_status(instance, google_cloud_apigee_v1_report_instance_status_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ReportInstanceStatusResponse

Reports the latest status for a runtime instance.

Parameters:

  • instance (String) —

    The name of the instance reporting this status. For SaaS the request will be rejected if no instance exists under this name. Format is organizations/org/ instances/instance

  • google_cloud_apigee_v1_report_instance_status_request_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1ReportInstanceStatusRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6887

def report_organization_instance_status(instance, google_cloud_apigee_v1_report_instance_status_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+instance}:reportStatus', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ReportInstanceStatusRequest::Representation
  command.request_object = google_cloud_apigee_v1_report_instance_status_request_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ReportInstanceStatusResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ReportInstanceStatusResponse
  command.params['instance'] = instance unless instance.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_organization_addons(org, google_cloud_apigee_v1_set_addons_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleLongrunningOperation

Configures the add-ons for the Apigee organization. The existing add-on configuration will be fully replaced.

Parameters:

  • org (String) —

    Required. Name of the organization. Use the following structure in your request: organizations/org``

  • google_cloud_apigee_v1_set_addons_request_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1SetAddonsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/google/apis/apigee_v1/service.rb', line 350

def set_organization_addons(org, google_cloud_apigee_v1_set_addons_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+org}:setAddons', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SetAddonsRequest::Representation
  command.request_object = google_cloud_apigee_v1_set_addons_request_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
  command.params['org'] = org unless org.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_organization_developer_developer_status(name, action: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleProtobufEmpty

Sets the status of a developer. A developer is active by default. If you set a developer's status to inactive, the API keys assigned to the developer apps are no longer valid even though the API keys are set to approved. Inactive developers can still sign in to the developer portal and create apps; however, any new API keys generated during app creation won't work. To set the status of a developer, set the action query parameter to active or inactive, and the Content-Type header to application/octet-stream. If successful, the API call returns the following HTTP status code: 204 No Content

Parameters:

  • name (String) —

    Required. Name of the developer. Use the following structure in your request: organizations/org/developers/developer_id``

  • action (String) (defaults to: nil) —

    Status of the developer. Valid values are active and inactive.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2182

def set_organization_developer_developer_status(name, action: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['action'] = action unless action.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_organization_environment_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleIamV1Policy

Sets the IAM policy on an environment, if the policy already exists it will be replaced. For more information, see Manage users, roles, and permissions using the API. You must have the apigee.environments. setIamPolicy permission to call this API.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

  • google_iam_v1_set_iam_policy_request_object (Google::Apis::ApigeeV1::GoogleIamV1SetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3841

def set_organization_environment_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleIamV1SetIamPolicyRequest::Representation
  command.request_object = google_iam_v1_set_iam_policy_request_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleIamV1Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_organization_sync_authorization(name, google_cloud_apigee_v1_sync_authorization_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1SyncAuthorization

Sets the permissions required to allow the Synchronizer to download environment data from the control plane. You must call this API to enable proper functioning of hybrid. Pass the ETag when calling setSyncAuthorization to ensure that you are updating the correct version. To get an ETag, call getSyncAuthorization. If you don't pass the ETag in the call to setSyncAuthorization, then the existing authorization is overwritten indiscriminately. For more information, see Configure the Synchronizer. Note: Available to Apigee hybrid only.

Parameters:

  • name (String) —

    Required. Name of the Apigee organization. Use the following structure in your request: organizations/org``

  • google_cloud_apigee_v1_sync_authorization_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1SyncAuthorization) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/google/apis/apigee_v1/service.rb', line 392

def set_organization_sync_authorization(name, google_cloud_apigee_v1_sync_authorization_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:setSyncAuthorization', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SyncAuthorization::Representation
  command.request_object = google_cloud_apigee_v1_sync_authorization_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SyncAuthorization::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SyncAuthorization
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#subscribe_organization_environment(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Subscription

Creates a subscription for the environment's Pub/Sub topic. The server will assign a random name for this subscription. The "name" and "push_config" must * not* be specified.

Parameters:

  • parent (String) —

    Required. Name of the environment. Use the following structure in your request: organizations/org/environments/env``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3876
3877
3878
3879
3880
3881
3882
3883
3884
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3876

def subscribe_organization_environment(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}:subscribe', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Subscription::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Subscription
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_organization_analytic_datastore(parent, google_cloud_apigee_v1_datastore_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1TestDatastoreResponse

Test if Datastore configuration is correct. This includes checking if credentials provided by customer have required permissions in target destination storage

Parameters:

  • parent (String) —

    Required. The parent organization name Must be of the form organizations/org

  • google_cloud_apigee_v1_datastore_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



593
594
595
596
597
598
599
600
601
602
603
 
# File 'lib/google/apis/apigee_v1/service.rb', line 593

def test_organization_analytic_datastore(parent, google_cloud_apigee_v1_datastore_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/analytics/datastores:test', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore::Representation
  command.request_object = google_cloud_apigee_v1_datastore_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TestDatastoreResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TestDatastoreResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_organization_environment_iam_permissions(resource, google_iam_v1_test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleIamV1TestIamPermissionsResponse

Tests the permissions of a user on an environment, and returns a subset of permissions that the user has on the environment. If the environment does not exist, an empty permission set is returned (a NOT_FOUND error is not returned).

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

  • google_iam_v1_test_iam_permissions_request_object (Google::Apis::ApigeeV1::GoogleIamV1TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3910

def test_organization_environment_iam_permissions(resource, google_iam_v1_test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleIamV1TestIamPermissionsRequest::Representation
  command.request_object = google_iam_v1_test_iam_permissions_request_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleIamV1TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleIamV1TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#undeploy_organization_environment_api_revision(name, sequenced_rollout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleProtobufEmpty

Undeploys an API proxy revision from an environment. For a request path organizations/org/environments/env/apis/api/revisions/rev/deployments, two permissions are required: * apigee.deployments.delete on the resource organizations/org/environments/env* `apigee.proxyrevisions.undeploy` on the resource `organizations/`org`/apis/`api`/revisions/`rev

Parameters:

  • name (String) —

    Required. Name of the API proxy revision deployment in the following format: organizations/org/environments/env/apis/api/revisions/rev``

  • sequenced_rollout (Boolean) (defaults to: nil) —

    Flag that specifies whether to enable sequenced rollout. If set to true, a best-effort attempt will be made to remove the environment group routing rules corresponding to this deployment before removing the deployment from the runtime. This is likely to be a rare use case; it is only needed when the intended effect of undeploying this proxy is to cause the traffic it currently handles to be rerouted to some other existing proxy in the environment group. The GenerateUndeployChangeReport API may be used to examine routing changes before issuing the undeployment request, and its response will indicate if a sequenced rollout is recommended for the undeployment.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4416

def undeploy_organization_environment_api_revision(name, sequenced_rollout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}/deployments', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['sequencedRollout'] = sequenced_rollout unless sequenced_rollout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#undeploy_organization_environment_sharedflow_revision(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleProtobufEmpty

Undeploys a shared flow revision from an environment. For a request path organizations/org/environments/env/sharedflows/sf/revisions/rev/ deployments, two permissions are required: * apigee.deployments.delete on the resource organizations/org/environments/env* `apigee. sharedflowrevisions.undeploy` on the resource `organizations/`org`/sharedflows/ `sf`/revisions/`rev

Parameters:

  • name (String) —

    Required. Name of the shared flow revision to undeploy in the following format: organizations/org/environments/env/sharedflows/sharedflow/revisions/ rev``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6021
6022
6023
6024
6025
6026
6027
6028
6029
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6021

def undeploy_organization_environment_sharedflow_revision(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}/deployments', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#unsubscribe_organization_environment(parent, google_cloud_apigee_v1_subscription_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleProtobufEmpty

Deletes a subscription for the environment's Pub/Sub topic.

Parameters:

  • parent (String) —

    Required. Name of the environment. Use the following structure in your request: organizations/org/environments/env``

  • google_cloud_apigee_v1_subscription_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1Subscription) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3944

def unsubscribe_organization_environment(parent, google_cloud_apigee_v1_subscription_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}:unsubscribe', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Subscription::Representation
  command.request_object = google_cloud_apigee_v1_subscription_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleProtobufEmpty
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_organization(name, google_cloud_apigee_v1_organization_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization

Updates the properties for an Apigee organization. No other fields in the organization profile will be updated.

Parameters:

  • name (String) —

    Required. Apigee organization name in the following format: organizations/ org``

  • google_cloud_apigee_v1_organization_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/google/apis/apigee_v1/service.rb', line 427

def update_organization(name, google_cloud_apigee_v1_organization_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization::Representation
  command.request_object = google_cloud_apigee_v1_organization_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_organization_analytic_datastore(name, google_cloud_apigee_v1_datastore_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore

Update a Datastore

Parameters:

  • name (String) —

    Required. The resource name of datastore to be updated. Must be of the form organizations/org/analytics/datastores/datastoreId``

  • google_cloud_apigee_v1_datastore_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



627
628
629
630
631
632
633
634
635
636
637
 
# File 'lib/google/apis/apigee_v1/service.rb', line 627

def update_organization_analytic_datastore(name, google_cloud_apigee_v1_datastore_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore::Representation
  command.request_object = google_cloud_apigee_v1_datastore_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_organization_api_revision_api_proxy_revision(name, google_api_http_body_object = nil, validate: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision

Updates an existing API proxy revision by uploading the API proxy configuration bundle as a zip file from your local machine. You can update only API proxy revisions that have never been deployed. After deployment, an API proxy revision becomes immutable, even if it is undeployed. Set the Content-Type header to either multipart/form-data or application/octet- stream.

Parameters:

  • name (String) —

    Required. API proxy revision to update in the following format: organizations/ org/apis/api/revisions/rev``

  • google_api_http_body_object (Google::Apis::ApigeeV1::GoogleApiHttpBody) (defaults to: nil)
  • validate (Boolean) (defaults to: nil) —

    Ignored. All uploads are validated regardless of the value of this field. Maintained for compatibility with Apigee Edge API.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1588

def update_organization_api_revision_api_proxy_revision(name, google_api_http_body_object = nil, validate: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation
  command.request_object = google_api_http_body_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision
  command.params['name'] = name unless name.nil?
  command.query['validate'] = validate unless validate.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_organization_apiproduct(name, google_cloud_apigee_v1_api_product_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct

Updates an existing API product. You must include all required values, whether or not you are updating them, as well as any optional values that you are updating. 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 UI or API. View the list of API products to identify their internal names.

Parameters:

  • name (String) —

    Required. Name of the API product. Use the following structure in your request: organizations/org/apiproducts/apiproduct``

  • google_cloud_apigee_v1_api_product_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



886
887
888
889
890
891
892
893
894
895
896
 
# File 'lib/google/apis/apigee_v1/service.rb', line 886

def update_organization_apiproduct(name, google_cloud_apigee_v1_api_product_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct::Representation
  command.request_object = google_cloud_apigee_v1_api_product_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_organization_apiproduct_attribute_api_product_attribute(name, google_cloud_apigee_v1_attribute_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute

Updates the value of an API product attribute. Note: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with entities also get cached for at least 180 seconds after entity is accessed during runtime. In this case, the ExpiresIn element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.

Parameters:

  • name (String) —

    Required. Name of the API product. Use the following structure in your request: organizations/org/apiproducts/apiproduct``

  • google_cloud_apigee_v1_attribute_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1020

def update_organization_apiproduct_attribute_api_product_attribute(name, google_cloud_apigee_v1_attribute_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation
  command.request_object = google_cloud_apigee_v1_attribute_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_organization_apiproduct_rateplan(name, google_cloud_apigee_v1_rate_plan_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan

Updates an existing rate plan.

Parameters:

  • name (String) —

    Required. Name of the rate plan. Use the following structure in your request: organizations/org/apiproducts/apiproduct/rateplans/rateplan``

  • google_cloud_apigee_v1_rate_plan_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1216

def update_organization_apiproduct_rateplan(name, google_cloud_apigee_v1_rate_plan_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan::Representation
  command.request_object = google_cloud_apigee_v1_rate_plan_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_organization_developer(name, google_cloud_apigee_v1_developer_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer

Updates a developer. This API replaces the existing developer details with those specified in the request. Include or exclude any existing details that you want to retain or delete, respectively. The custom attribute limit is 18. * Note*: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an ExpiresIn element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.

Parameters:

  • name (String) —

    Required. Email address of the developer. Use the following structure in your request: organizations/org/developers/developer_email``

  • google_cloud_apigee_v1_developer_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2223

def update_organization_developer(name, google_cloud_apigee_v1_developer_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer::Representation
  command.request_object = google_cloud_apigee_v1_developer_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_organization_developer_app(name, google_cloud_apigee_v1_developer_app_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp

Updates the details for a developer app. In addition, you can add an API product to a developer app and automatically generate an API key for the app to use when calling APIs in the API product. If you want to use an existing API key for the API product, add the API product to the API key using the UpdateDeveloperAppKey API. Using this API, you cannot update the following: * App name as it is the primary key used to identify the app and cannot be changed. * Scopes associated with the app. Instead, use the ReplaceDeveloperAppKey API. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively.

Parameters:

  • name (String) —

    Required. Name of the developer app. Use the following structure in your request: organizations/org/developers/developer_email/apps/app``

  • google_cloud_apigee_v1_developer_app_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2528

def update_organization_developer_app(name, google_cloud_apigee_v1_developer_app_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp::Representation
  command.request_object = google_cloud_apigee_v1_developer_app_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_organization_developer_app_attribute_developer_app_attribute(name, google_cloud_apigee_v1_attribute_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute

Updates a developer app attribute. Note: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an ExpiresIn element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.

Parameters:

  • name (String) —

    Required. Name of the developer app attribute. Use the following structure in your request: organizations/org/developers/developer_email/apps/app/ attributes/attribute``

  • google_cloud_apigee_v1_attribute_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2663

def update_organization_developer_app_attribute_developer_app_attribute(name, google_cloud_apigee_v1_attribute_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation
  command.request_object = google_cloud_apigee_v1_attribute_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_organization_developer_app_key_apiproduct_developer_app_key_api_product(name, action: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleProtobufEmpty

Approves or revokes the consumer key for an API product. After a consumer key is approved, the app can use it to access APIs. A consumer key that is revoked or pending cannot be used to access an API. Any access tokens associated with a revoked consumer key will remain active. However, Apigee checks the status of the consumer key and if set to revoked will not allow access to the API.

Parameters:

  • name (String) —

    Name of the API product in the developer app key in the following format: organizations/org/developers/developer_email/apps/app/keys/key/ apiproducts/apiproduct``

  • action (String) (defaults to: nil) —

    Approve or revoke the consumer key by setting this value to approve or revoke, respectively.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2933

def update_organization_developer_app_key_apiproduct_developer_app_key_api_product(name, action: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['action'] = action unless action.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_organization_developer_app_key_developer_app_key(name, google_cloud_apigee_v1_developer_app_key_object = nil, action: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey

Adds an API product to a developer app key, enabling the app that holds the key to access the API resources bundled in the API product. In addition, you can add attributes to a developer app key. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively. You can use the same key to access all API products associated with the app.

Parameters:

  • name (String) —

    Name of the developer app key. Use the following structure in your request: organizations/org/developers/developer_email/apps/app/keys/key``

  • google_cloud_apigee_v1_developer_app_key_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey) (defaults to: nil)
  • action (String) (defaults to: nil) —

    Approve or revoke the consumer key by setting this value to approve or revoke, respectively.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2856

def update_organization_developer_app_key_developer_app_key(name, google_cloud_apigee_v1_developer_app_key_object = nil, action: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation
  command.request_object = google_cloud_apigee_v1_developer_app_key_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey
  command.params['name'] = name unless name.nil?
  command.query['action'] = action unless action.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_organization_developer_attribute_developer_attribute(name, google_cloud_apigee_v1_attribute_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute

Updates a developer attribute. Note: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an ExpiresIn element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.

Parameters:

  • name (String) —

    Required. Name of the developer attribute. Use the following structure in your request: organizations/org/developers/developer_email/attributes/ attribute``

  • google_cloud_apigee_v1_attribute_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3112

def update_organization_developer_attribute_developer_attribute(name, google_cloud_apigee_v1_attribute_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation
  command.request_object = google_cloud_apigee_v1_attribute_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_organization_environment(name, google_cloud_apigee_v1_environment_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment

Updates an existing environment. When updating properties, you must pass all existing properties to the API, even if they are not being changed. If you omit properties from the payload, the properties are removed. To get the current list of properties for the environment, use the Get Environment API.

Parameters:

  • name (String) —

    Required. Name of the environment. Use the following structure in your request: organizations/org/environments/env``

  • google_cloud_apigee_v1_environment_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3982

def update_organization_environment(name, google_cloud_apigee_v1_environment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment::Representation
  command.request_object = google_cloud_apigee_v1_environment_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_organization_environment_debugmask(name, google_cloud_apigee_v1_debug_mask_object = nil, replace_repeated_fields: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask

Updates the debug mask singleton resource for an environment.

Parameters:

  • name (String) —

    Name of the debug mask.

  • google_cloud_apigee_v1_debug_mask_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask) (defaults to: nil)
  • replace_repeated_fields (Boolean) (defaults to: nil) —

    Boolean flag that specifies whether to replace existing values in the debug mask when doing an update. Set to true to replace existing values. The default behavior is to append the values (false).

  • update_mask (String) (defaults to: nil) —

    Field debug mask to support partial updates.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4021

def update_organization_environment_debugmask(name, google_cloud_apigee_v1_debug_mask_object = nil, replace_repeated_fields: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask::Representation
  command.request_object = google_cloud_apigee_v1_debug_mask_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask
  command.params['name'] = name unless name.nil?
  command.query['replaceRepeatedFields'] = replace_repeated_fields unless replace_repeated_fields.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_organization_environment_environment(name, google_cloud_apigee_v1_environment_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment

Updates an existing environment. When updating properties, you must pass all existing properties to the API, even if they are not being changed. If you omit properties from the payload, the properties are removed. To get the current list of properties for the environment, use the Get Environment API.

Parameters:

  • name (String) —

    Required. Name of the environment. Use the following structure in your request: organizations/org/environments/env``

  • google_cloud_apigee_v1_environment_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4061

def update_organization_environment_environment(name, google_cloud_apigee_v1_environment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment::Representation
  command.request_object = google_cloud_apigee_v1_environment_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_organization_environment_keystore_alias(name, google_api_http_body_object = nil, ignore_expiry_validation: nil, ignore_newline_validation: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias

Updates the certificate in an alias.

Parameters:

  • name (String) —

    Required. Name of the alias. Use the following format in your request: organizations/org/environments/env/keystores/keystore/aliases/alias``

  • google_api_http_body_object (Google::Apis::ApigeeV1::GoogleApiHttpBody) (defaults to: nil)
  • ignore_expiry_validation (Boolean) (defaults to: nil) —

    Required. Flag that specifies whether to ignore expiry validation. If set to true, no expiry validation will be performed.

  • ignore_newline_validation (Boolean) (defaults to: nil) —

    Flag that specifies whether to ignore newline validation. If set to true, no error is thrown when the file contains a certificate chain with no newline between each certificate. Defaults to false.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5180

def update_organization_environment_keystore_alias(name, google_api_http_body_object = nil, ignore_expiry_validation: nil, ignore_newline_validation: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation
  command.request_object = google_api_http_body_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias
  command.params['name'] = name unless name.nil?
  command.query['ignoreExpiryValidation'] = ignore_expiry_validation unless ignore_expiry_validation.nil?
  command.query['ignoreNewlineValidation'] = ignore_newline_validation unless ignore_newline_validation.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_organization_environment_reference(name, google_cloud_apigee_v1_reference_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference

Updates an existing Reference. Note that this operation has PUT semantics; it will replace the entirety of the existing Reference with the resource in the request body.

Parameters:

  • name (String) —

    Required. The name of the Reference to update. Must be of the form organizations/org/environments/env/references/ref``.

  • google_cloud_apigee_v1_reference_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5631

def update_organization_environment_reference(name, google_cloud_apigee_v1_reference_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference::Representation
  command.request_object = google_cloud_apigee_v1_reference_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_organization_environment_resourcefile(parent, type, name, google_api_http_body_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile

Updates a resource file. Specify the Content-Type as application/octet- stream or multipart/form-data. For more information about resource files, see Resource files.

Parameters:

  • parent (String) —

    Required. Name of the environment in the following format: organizations/org /environments/env``.

  • type (String) —

    Required. Resource file type. resource_file_type

  • name (String) —

    Required. ID of the resource file to update. Must match the regular expression: [a-zA-Z0-9:/\!@#$%^&`\[\]()+\-=,.~' ]1,255

  • google_api_http_body_object (Google::Apis::ApigeeV1::GoogleApiHttpBody) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5869

def update_organization_environment_resourcefile(parent, type, name, google_api_http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+parent}/resourcefiles/{type}/{name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation
  command.request_object = google_api_http_body_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile
  command.params['parent'] = parent unless parent.nil?
  command.params['type'] = type unless type.nil?
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_organization_environment_targetserver(name, google_cloud_apigee_v1_target_server_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer

Updates an existing TargetServer. Note that this operation has PUT semantics; it will replace the entirety of the existing TargetServer with the resource in the request body.

Parameters:

  • name (String) —

    Required. The name of the TargetServer to replace. Must be of the form organizations/org/environments/env/targetservers/target_server_id``.

  • google_cloud_apigee_v1_target_server_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6252

def update_organization_environment_targetserver(name, google_cloud_apigee_v1_target_server_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer::Representation
  command.request_object = google_cloud_apigee_v1_target_server_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_organization_environment_trace_config(name, google_cloud_apigee_v1_trace_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1TraceConfig

Updates the trace configurations in an environment. Note that the repeated fields have replace semantics when included in the field mask and that they will be overwritten by the value of the fields in the request body.

Parameters:

  • name (String) —

    Required. Name of the trace configuration. Use the following structure in your request: "organizations//environments//traceConfig".

  • google_cloud_apigee_v1_trace_config_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1TraceConfig) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    List of fields to be updated.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4099

def update_organization_environment_trace_config(name, google_cloud_apigee_v1_trace_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TraceConfig::Representation
  command.request_object = google_cloud_apigee_v1_trace_config_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TraceConfig::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TraceConfig
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_organization_report(name, google_cloud_apigee_v1_custom_report_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport

Update an existing custom report definition

Parameters:

  • name (String) —

    Required. Custom Report name of the form: organizations/organization_id/ reports/report_name``

  • google_cloud_apigee_v1_custom_report_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7659

def update_organization_report(name, google_cloud_apigee_v1_custom_report_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport::Representation
  command.request_object = google_cloud_apigee_v1_custom_report_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_organization_sharedflow_revision_shared_flow_revision(name, google_api_http_body_object = nil, validate: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision

Updates a shared flow revision. This operation is only allowed on revisions which have never been deployed. After deployment a revision becomes immutable, even if it becomes undeployed. The payload is a ZIP-formatted shared flow. Content type must be either multipart/form-data or application/octet-stream.

Parameters:

  • name (String) —

    Required. The name of the shared flow revision to update. Must be of the form: organizations/organization_id/sharedflows/shared_flow_id/revisions/ revision_id``

  • google_api_http_body_object (Google::Apis::ApigeeV1::GoogleApiHttpBody) (defaults to: nil)
  • validate (Boolean) (defaults to: nil) —

    Ignored. All uploads are validated regardless of the value of this field. It is kept for compatibility with existing APIs. Must be true or false if provided.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7951

def update_organization_sharedflow_revision_shared_flow_revision(name, google_api_http_body_object = nil, validate: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation
  command.request_object = google_api_http_body_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision
  command.params['name'] = name unless name.nil?
  command.query['validate'] = validate unless validate.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end