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



6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6710

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



4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4367

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



604
605
606
607
608
609
610
611
612
613
614
 
# File 'lib/google/apis/apigee_v1/service.rb', line 604

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 in the following format: 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



1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1707

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



1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1995

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



395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/google/apis/apigee_v1/service.rb', line 395

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



1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1011

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



1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1180

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



653
654
655
656
657
658
659
660
661
662
663
 
# File 'lib/google/apis/apigee_v1/service.rb', line 653

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



1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1490

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



1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1743

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



2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2034

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 hybrid 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



2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2444

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 hybrid 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



2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2713

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



2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2885

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



3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3057

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



3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3195

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



3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3765

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



4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4040

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



4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4470

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



4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4596

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



4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4803

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



4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4965

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



5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5119

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



5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5260

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



5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5739

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



5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5876

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



6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6058

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



6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6336

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



6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6509

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



6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6644

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



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

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



6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6884

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



7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7116

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



7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7288

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



7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7601

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



4635
4636
4637
4638
4639
4640
4641
4642
4643
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4635

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



428
429
430
431
432
433
434
435
436
 
# File 'lib/google/apis/apigee_v1/service.rb', line 428

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



1048
1049
1050
1051
1052
1053
1054
1055
1056
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1048

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



1213
1214
1215
1216
1217
1218
1219
1220
1221
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1213

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



1246
1247
1248
1249
1250
1251
1252
1253
1254
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1246

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



693
694
695
696
697
698
699
700
701
 
# File 'lib/google/apis/apigee_v1/service.rb', line 693

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



854
855
856
857
858
859
860
861
862
 
# File 'lib/google/apis/apigee_v1/service.rb', line 854

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



1524
1525
1526
1527
1528
1529
1530
1531
1532
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1524

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



1782
1783
1784
1785
1786
1787
1788
1789
1790
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1782

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



2070
2071
2072
2073
2074
2075
2076
2077
2078
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2070

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



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

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



2483
2484
2485
2486
2487
2488
2489
2490
2491
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2483

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



2631
2632
2633
2634
2635
2636
2637
2638
2639
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2631

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



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

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



2919
2920
2921
2922
2923
2924
2925
2926
2927
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2919

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



3090
3091
3092
3093
3094
3095
3096
3097
3098
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3090

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



3229
3230
3231
3232
3233
3234
3235
3236
3237
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3229

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



4077
4078
4079
4080
4081
4082
4083
4084
4085
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4077

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



4298
4299
4300
4301
4302
4303
4304
4305
4306
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4298

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



4504
4505
4506
4507
4508
4509
4510
4511
4512
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4504

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



4666
4667
4668
4669
4670
4671
4672
4673
4674
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4666

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



4836
4837
4838
4839
4840
4841
4842
4843
4844
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4836

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



5153
5154
5155
5156
5157
5158
5159
5160
5161
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5153

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



5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5302

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



5774
5775
5776
5777
5778
5779
5780
5781
5782
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5774

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



5910
5911
5912
5913
5914
5915
5916
5917
5918
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5910

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



6370
6371
6372
6373
6374
6375
6376
6377
6378
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6370

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



6542
6543
6544
6545
6546
6547
6548
6549
6550
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6542

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



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

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



6917
6918
6919
6920
6921
6922
6923
6924
6925
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6917

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



7149
7150
7151
7152
7153
7154
7155
7156
7157
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7149

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



7324
7325
7326
7327
7328
7329
7330
7331
7332
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7324

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



7456
7457
7458
7459
7460
7461
7462
7463
7464
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7456

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



7634
7635
7636
7637
7638
7639
7640
7641
7642
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7634

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



3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3922

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



5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5537

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



4400
4401
4402
4403
4404
4405
4406
4407
4408
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4400

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

#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



2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2126

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



4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4224

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



4267
4268
4269
4270
4271
4272
4273
4274
4275
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4267

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



459
460
461
462
463
464
465
466
467
 
# File 'lib/google/apis/apigee_v1/service.rb', line 459

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



1079
1080
1081
1082
1083
1084
1085
1086
1087
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1079

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, do the following: * Set the format query parameter to bundle. * Set the Accept header to application/zip. 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



1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1286

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



728
729
730
731
732
733
734
735
736
 
# File 'lib/google/apis/apigee_v1/service.rb', line 728

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



886
887
888
889
890
891
892
893
894
 
# File 'lib/google/apis/apigee_v1/service.rb', line 886

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



1392
1393
1394
1395
1396
1397
1398
1399
1400
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1392

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



1555
1556
1557
1558
1559
1560
1561
1562
1563
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1555

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



1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1817

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



2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2168

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



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

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

Returns 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



2515
2516
2517
2518
2519
2520
2521
2522
2523
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2515

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



2779
2780
2781
2782
2783
2784
2785
2786
2787
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2779

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



2950
2951
2952
2953
2954
2955
2956
2957
2958
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2950

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



3121
3122
3123
3124
3125
3126
3127
3128
3129
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3121

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



3260
3261
3262
3263
3264
3265
3266
3267
3268
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3260

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, type: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Schema

Get a list of metrics and dimensions which can be used for creating analytics queries and reports. Each schema element contains the name of the field with its associated type and if it is either custom field or standard field.

Parameters:

  • name (String) —

    Required. The parent organization and environment names. Must be of the form organizations/org/environments/env/analytics/admin/schemav2.

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

    Required. Type refers to the dataset name whose schema needs to be retrieved E. g. type=fact or type=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



3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3730

def get_organization_environment_analytic_admin_schemav2(name, 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['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



3800
3801
3802
3803
3804
3805
3806
3807
3808
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3800

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



4109
4110
4111
4112
4113
4114
4115
4116
4117
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4109

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



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

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



3957
3958
3959
3960
3961
3962
3963
3964
3965
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3957

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



3291
3292
3293
3294
3295
3296
3297
3298
3299
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3291

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



3323
3324
3325
3326
3327
3328
3329
3330
3331
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3323

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



4433
4434
4435
4436
4437
4438
4439
4440
4441
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4433

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



3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3365

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



4535
4536
4537
4538
4539
4540
4541
4542
4543
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4535

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



4697
4698
4699
4700
4701
4702
4703
4704
4705
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4697

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



4728
4729
4730
4731
4732
4733
4734
4735
4736
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4728

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



4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4915

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



5000
5001
5002
5003
5004
5005
5006
5007
5008
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5000

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



5035
5036
5037
5038
5039
5040
5041
5042
5043
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5035

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



5184
5185
5186
5187
5188
5189
5190
5191
5192
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5184

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



5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5342

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



5571
5572
5573
5574
5575
5576
5577
5578
5579
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5571

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



5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5689

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



5805
5806
5807
5808
5809
5810
5811
5812
5813
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5805

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



3397
3398
3399
3400
3401
3402
3403
3404
3405
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3397

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



5942
5943
5944
5945
5946
5947
5948
5949
5950
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5942

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



6093
6094
6095
6096
6097
6098
6099
6100
6101
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6093

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



6128
6129
6130
6131
6132
6133
6134
6135
6136
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6128

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



6159
6160
6161
6162
6163
6164
6165
6166
6167
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6159

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



6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6288

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



6402
6403
6404
6405
6406
6407
6408
6409
6410
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6402

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



6573
6574
6575
6576
6577
6578
6579
6580
6581
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6573

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



6677
6678
6679
6680
6681
6682
6683
6684
6685
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6677

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



6813
6814
6815
6816
6817
6818
6819
6820
6821
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6813

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



6948
6949
6950
6951
6952
6953
6954
6955
6956
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6948

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



7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7064

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



7180
7181
7182
7183
7184
7185
7186
7187
7188
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7180

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



7355
7356
7357
7358
7359
7360
7361
7362
7363
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7355

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. If format=bundle is passed, it instead outputs a shared flow revision as a ZIP-formatted bundle of code and config files.

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



7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7493

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



7665
7666
7667
7668
7669
7670
7671
7672
7673
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7665

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



252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/google/apis/apigee_v1/service.rb', line 252

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



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

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



1148
1149
1150
1151
1152
1153
1154
1155
1156
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1148

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



1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1362

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



917
918
919
920
921
922
923
924
925
 
# File 'lib/google/apis/apigee_v1/service.rb', line 917

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_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 limit on the number of API products returned by the API 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



778
779
780
781
782
783
784
785
786
787
788
789
790
791
 
# File 'lib/google/apis/apigee_v1/service.rb', line 778

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



1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1115

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



1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1446

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



1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1591

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



1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1665

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



2362
2363
2364
2365
2366
2367
2368
2369
2370
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2362

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



2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2220

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 in the following format: 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



2810
2811
2812
2813
2814
2815
2816
2817
2818
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2810

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



1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1874

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



3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3158

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



2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2986

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



3832
3833
3834
3835
3836
3837
3838
3839
3840
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3832

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



3863
3864
3865
3866
3867
3868
3869
3870
3871
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3863

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



4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4146

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



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

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



5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5081

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



5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5415

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



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

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



5491
5492
5493
5494
5495
5496
5497
5498
5499
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5491

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



5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5982

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



6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6206

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



6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6610

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



6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6850

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



6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6439

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



6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6991

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



7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7213

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



7423
7424
7425
7426
7427
7428
7429
7430
7431
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7423

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



7569
7570
7571
7572
7573
7574
7575
7576
7577
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7569

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



7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7390

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



7696
7697
7698
7699
7700
7701
7702
7703
7704
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7696

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



286
287
288
289
290
291
292
293
294
 
# File 'lib/google/apis/apigee_v1/service.rb', line 286

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



1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1627

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



3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3022

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



6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6021

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



7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7728

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



7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7763

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



2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2551

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



6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6474

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_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. Valid values are active or inactive. 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. If successful, the API call returns the following HTTP status code: 204 No Content

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



1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1919

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



3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3433

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



326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/google/apis/apigee_v1/service.rb', line 326

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



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

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



527
528
529
530
531
532
533
534
535
536
537
 
# File 'lib/google/apis/apigee_v1/service.rb', line 527

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



3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3502

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



4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4003

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



5608
5609
5610
5611
5612
5613
5614
5615
5616
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5608

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



3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3536

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



361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/google/apis/apigee_v1/service.rb', line 361

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



561
562
563
564
565
566
567
568
569
570
571
 
# File 'lib/google/apis/apigee_v1/service.rb', line 561

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



1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1327

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



820
821
822
823
824
825
826
827
828
829
830
 
# File 'lib/google/apis/apigee_v1/service.rb', line 820

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



954
955
956
957
958
959
960
961
962
963
964
 
# File 'lib/google/apis/apigee_v1/service.rb', line 954

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



1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1960

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



2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2265

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



2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2400

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

Approve or revoke an app's consumer key. 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 hybrid 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



2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2670

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



2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2593

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



2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2848

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



3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3574

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



3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3613

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



3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3653

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



4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4767

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



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

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



5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5456

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



5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5839

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



3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3691

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



7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7246

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



7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7534

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