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



8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8546

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

#adjust_organization_developer_balance(name, google_cloud_apigee_v1_adjust_developer_balance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperBalance

Adjust the prepaid balance for the developer. This API will be used in scenarios where the developer has been under-charged or over-charged.

Parameters:

  • name (String) —

    Required. Account balance for the developer. Use the following structure in your request: organizations/org/developers/developer/balance

  • google_cloud_apigee_v1_adjust_developer_balance_request_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1AdjustDeveloperBalanceRequest) (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



3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3479

def adjust_organization_developer_balance(name, google_cloud_apigee_v1_adjust_developer_balance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:adjust', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AdjustDeveloperBalanceRequest::Representation
  command.request_object = google_cloud_apigee_v1_adjust_developer_balance_request_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperBalance::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperBalance
  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



5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5590

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



712
713
714
715
716
717
718
719
720
721
722
 
# File 'lib/google/apis/apigee_v1/service.rb', line 712

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

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

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

Parameters:

  • parent (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2202

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



2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2590

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

#compute_organization_security_profile_environment_environment_scores(profile_environment, google_cloud_apigee_v1_compute_environment_scores_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ComputeEnvironmentScoresResponse

ComputeEnvironmentScores calculates scores for requested time range for the specified security profile and environment.

Parameters:

  • profile_environment (String) —

    Required. Name of organization and environment and profile id for which score needs to be computed. Format: organizations/org/securityProfiles/profile/ environments/env

  • google_cloud_apigee_v1_compute_environment_scores_request_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1ComputeEnvironmentScoresRequest) (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



9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9387

def compute_organization_security_profile_environment_environment_scores(profile_environment, google_cloud_apigee_v1_compute_environment_scores_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+profileEnvironment}:computeEnvironmentScores', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ComputeEnvironmentScoresRequest::Representation
  command.request_object = google_cloud_apigee_v1_compute_environment_scores_request_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ComputeEnvironmentScoresResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ComputeEnvironmentScoresResponse
  command.params['profileEnvironment'] = profile_environment unless profile_environment.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



503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/google/apis/apigee_v1/service.rb', line 503

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



1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1315

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. Name of the environment in which to create the key value map. Use the following structure in your request: organizations/org/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



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

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_api_keyvaluemap_entry(parent, google_cloud_apigee_v1_key_value_entry_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueEntry

Creates key value entries in a key value map scoped to an organization, environment, or API proxy.

Parameters:

  • parent (String) —

    Required. Scope as indicated by the URI in which to create the key value map entry. Use one of the following structures in your request: * organizations/organization/apis/api/keyvaluemaps/keyvaluemap. * ` organizations/`organization`/environments/`environment`/keyvaluemaps/` keyvaluemap * organizations/organization/keyvaluemaps/keyvaluemap``.

  • google_cloud_apigee_v1_key_value_entry_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueEntry) (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



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

def create_organization_api_keyvaluemap_entry(parent, google_cloud_apigee_v1_key_value_entry_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/entries', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueEntry::Representation
  command.request_object = google_cloud_apigee_v1_key_value_entry_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueEntry::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueEntry
  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



761
762
763
764
765
766
767
768
769
770
771
 
# File 'lib/google/apis/apigee_v1/service.rb', line 761

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

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

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

Parameters:

  • parent (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1105

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

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

Creates a new data collector.

Parameters:

  • parent (String) —

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

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

    ID of the data collector. Overrides any ID in the data collector resource. Must be a string beginning with dc_ that contains only letters, numbers, and underscores.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1985

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



2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2238

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



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

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

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

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

Parameters:

  • parent (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3038

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

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

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

Parameters:

  • parent (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3308

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

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

Creates a subscription to an API product.

Parameters:

  • parent (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3548

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

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

Creates an endpoint attachment. Note: Not supported for Apigee hybrid.

Parameters:

  • parent (String) —

    Required. Organization the endpoint attachment will be created in.

  • google_cloud_apigee_v1_endpoint_attachment_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1EndpointAttachment) (defaults to: nil)
  • endpoint_attachment_id (String) (defaults to: nil) —

    ID to use for the endpoint attachment. The ID can contain lowercase letters and numbers, must start with a letter, and must be 1-20 characters in length.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

def create_organization_endpoint_attachment(parent, google_cloud_apigee_v1_endpoint_attachment_object = nil, endpoint_attachment_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/endpointAttachments', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1EndpointAttachment::Representation
  command.request_object = google_cloud_apigee_v1_endpoint_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['endpointAttachmentId'] = endpoint_attachment_id unless endpoint_attachment_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_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



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

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



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

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



4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4142

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



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

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



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

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_archive_deployment(parent, google_cloud_apigee_v1_archive_deployment_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleLongrunningOperation

Creates a new ArchiveDeployment.

Parameters:

  • parent (String) —

    Required. The Environment this Archive Deployment will be created in.

  • google_cloud_apigee_v1_archive_deployment_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1ArchiveDeployment) (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



5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5266

def create_organization_environment_archive_deployment(parent, google_cloud_apigee_v1_archive_deployment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/archiveDeployments', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ArchiveDeployment::Representation
  command.request_object = google_cloud_apigee_v1_archive_deployment_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_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



5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5693

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



5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5819

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. Name of the environment in which to create the key value map. Use the following structure in your request: organizations/org/environments/ env``

  • 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



6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6027

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_keyvaluemap_entry(parent, google_cloud_apigee_v1_key_value_entry_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueEntry

Creates key value entries in a key value map scoped to an organization, environment, or API proxy.

Parameters:

  • parent (String) —

    Required. Scope as indicated by the URI in which to create the key value map entry. Use one of the following structures in your request: * organizations/organization/apis/api/keyvaluemaps/keyvaluemap. * ` organizations/`organization`/environments/`environment`/keyvaluemaps/` keyvaluemap * organizations/organization/keyvaluemaps/keyvaluemap``.

  • google_cloud_apigee_v1_key_value_entry_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueEntry) (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



6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6096

def create_organization_environment_keyvaluemap_entry(parent, google_cloud_apigee_v1_key_value_entry_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/entries', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueEntry::Representation
  command.request_object = google_cloud_apigee_v1_key_value_entry_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueEntry::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueEntry
  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



6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6340

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



6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6527

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



6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6668

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_security_report(parent, google_cloud_apigee_v1_security_report_query_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityReport

Submit a report request to be processed in the background. If the submission succeeds, the API returns a 200 status and an ID that refer to the report request. In addition to the HTTP status 200, 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_security_report_query_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityReportQuery) (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



6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6903

def create_organization_environment_security_report(parent, google_cloud_apigee_v1_security_report_query_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/securityReports', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityReportQuery::Representation
  command.request_object = google_cloud_apigee_v1_security_report_query_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityReport::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityReport
  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_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



7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7343

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



7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7480

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



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

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_host_security_report(parent, google_cloud_apigee_v1_security_report_query_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityReport

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_security_report_query_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityReportQuery) (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



7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7851

def create_organization_host_security_report(parent, google_cloud_apigee_v1_security_report_query_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/hostSecurityReports', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityReportQuery::Representation
  command.request_object = google_cloud_apigee_v1_security_report_query_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityReport::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityReport
  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



8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8133

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



8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8345

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



8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8480

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



8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8584

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. Name of the organization in which to create the key value map file. Use the following structure in your request: organizations/org``

  • 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



8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8720

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_keyvaluemap_entry(parent, google_cloud_apigee_v1_key_value_entry_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueEntry

Creates key value entries in a key value map scoped to an organization, environment, or API proxy.

Parameters:

  • parent (String) —

    Required. Scope as indicated by the URI in which to create the key value map entry. Use one of the following structures in your request: * organizations/organization/apis/api/keyvaluemaps/keyvaluemap. * ` organizations/`organization`/environments/`environment`/keyvaluemaps/` keyvaluemap * organizations/organization/keyvaluemaps/keyvaluemap``.

  • google_cloud_apigee_v1_key_value_entry_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueEntry) (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



8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8789

def create_organization_keyvaluemap_entry(parent, google_cloud_apigee_v1_key_value_entry_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/entries', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueEntry::Representation
  command.request_object = google_cloud_apigee_v1_key_value_entry_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueEntry::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueEntry
  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



9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9108

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_security_profile_environment(parent, google_cloud_apigee_v1_security_profile_environment_association_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation

CreateSecurityProfileEnvironmentAssociation creates profile environment association i.e. attaches environment to security profile.

Parameters:

  • parent (String) —

    Required. Name of organization and security profile ID. Format: organizations/ org/securityProfiles/profile

  • google_cloud_apigee_v1_security_profile_environment_association_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation) (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



9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9422

def create_organization_security_profile_environment(parent, google_cloud_apigee_v1_security_profile_environment_association_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/environments', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation::Representation
  command.request_object = google_cloud_apigee_v1_security_profile_environment_association_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation
  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



9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9496

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



9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9813

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

#credit_organization_developer_balance(name, google_cloud_apigee_v1_credit_developer_balance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperBalance

Credits the account balance for the developer.

Parameters:

  • name (String) —

    Required. Account balance for the developer. Use the following structure in your request: organizations/org/developers/developer/balance

  • google_cloud_apigee_v1_credit_developer_balance_request_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1CreditDeveloperBalanceRequest) (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



3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3513

def credit_organization_developer_balance(name, google_cloud_apigee_v1_credit_developer_balance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:credit', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CreditDeveloperBalanceRequest::Representation
  command.request_object = google_cloud_apigee_v1_credit_developer_balance_request_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperBalance::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperBalance
  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

#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



5858
5859
5860
5861
5862
5863
5864
5865
5866
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5858

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

Delete an Apigee organization. For organizations with BillingType EVALUATION, an immediate deletion is performed. For paid organizations, a soft-deletion is performed. The organization can be restored within the soft-deletion period which can be controlled using the retention field in the request.

Parameters:

  • name (String) —

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

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

    Optional. This setting is applicable only for organizations that are soft- deleted (i.e., BillingType is not EVALUATION). It controls how long Organization data will be retained after the initial delete operation completes. During this period, the Organization may be restored to its last known state. After this period, the Organization will no longer be able to be restored.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



154
155
156
157
158
159
160
161
162
163
 
# File 'lib/google/apis/apigee_v1/service.rb', line 154

def delete_organization(name, retention: nil, 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['retention'] = retention unless retention.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



536
537
538
539
540
541
542
543
544
 
# File 'lib/google/apis/apigee_v1/service.rb', line 536

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



1352
1353
1354
1355
1356
1357
1358
1359
1360
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1352

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

Deletes a key value map from an API proxy.

Parameters:

  • name (String) —

    Required. Name of the key value map. Use the following structure in your request: organizations/org/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



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

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

Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. Note: After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior.

Parameters:

  • name (String) —

    Required. Scope as indicated by the URI in which to delete the key value map entry. Use one of the following structures in your request: * organizations/organization/apis/api/keyvaluemaps/keyvaluemap/entries/ entry. * `organizations/`organization`/environments/`environment`/ keyvaluemaps/`keyvaluemap`/entries/`entry * organizations/organization/ keyvaluemaps/keyvaluemap/entries/entry``.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

def delete_organization_api_keyvaluemap_entry(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueEntry::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueEntry
  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



1741
1742
1743
1744
1745
1746
1747
1748
1749
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1741

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



801
802
803
804
805
806
807
808
809
 
# File 'lib/google/apis/apigee_v1/service.rb', line 801

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



962
963
964
965
966
967
968
969
970
 
# File 'lib/google/apis/apigee_v1/service.rb', line 962

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

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

Deletes a rate plan.

Parameters:

  • name (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1138
1139
1140
1141
1142
1143
1144
1145
1146
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1138

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

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

Deletes a data collector.

Parameters:

  • name (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2019
2020
2021
2022
2023
2024
2025
2026
2027
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2019

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



2277
2278
2279
2280
2281
2282
2283
2284
2285
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2277

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



2665
2666
2667
2668
2669
2670
2671
2672
2673
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2665

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



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

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



3077
3078
3079
3080
3081
3082
3083
3084
3085
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3077

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



3226
3227
3228
3229
3230
3231
3232
3233
3234
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3226

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



3342
3343
3344
3345
3346
3347
3348
3349
3350
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3342

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

Deletes an endpoint attachment.

Parameters:

  • name (String) —

    Required. Name of the endpoint attachment. Use the following structure in your request: organizations/org/endpointAttachments/endpoint_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



3727
3728
3729
3730
3731
3732
3733
3734
3735
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3727

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



3866
3867
3868
3869
3870
3871
3872
3873
3874
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3866

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



4037
4038
4039
4040
4041
4042
4043
4044
4045
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4037

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. Warning: You must delete all key value maps and key value entries before you delete an environment. Otherwise, if you re-create the environment the key value map entry operations will encounter encryption/decryption discrepancies.

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



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

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



5045
5046
5047
5048
5049
5050
5051
5052
5053
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5045

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

Deletes an archive deployment.

Parameters:

  • name (String) —

    Required. Name of the Archive Deployment in the following format: organizations/org/environments/env/archiveDeployments/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



5299
5300
5301
5302
5303
5304
5305
5306
5307
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5299

def delete_organization_environment_archive_deployment(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_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



5521
5522
5523
5524
5525
5526
5527
5528
5529
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5521

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



5727
5728
5729
5730
5731
5732
5733
5734
5735
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5727

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



5889
5890
5891
5892
5893
5894
5895
5896
5897
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5889

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

Deletes a key value map from an environment.

Parameters:

  • name (String) —

    Required. Name of the key value map. Use the following structure in your request: organizations/org/environments/env/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



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

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

Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. Note: After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior.

Parameters:

  • name (String) —

    Required. Scope as indicated by the URI in which to delete the key value map entry. Use one of the following structures in your request: * organizations/organization/apis/api/keyvaluemaps/keyvaluemap/entries/ entry. * `organizations/`organization`/environments/`environment`/ keyvaluemaps/`keyvaluemap`/entries/`entry * organizations/organization/ keyvaluemaps/keyvaluemap/entries/entry``.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6136
6137
6138
6139
6140
6141
6142
6143
6144
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6136

def delete_organization_environment_keyvaluemap_entry(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueEntry::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueEntry
  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



6561
6562
6563
6564
6565
6566
6567
6568
6569
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6561

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



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

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



7378
7379
7380
7381
7382
7383
7384
7385
7386
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7378

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



7514
7515
7516
7517
7518
7519
7520
7521
7522
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7514

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



8167
8168
8169
8170
8171
8172
8173
8174
8175
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8167

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



8378
8379
8380
8381
8382
8383
8384
8385
8386
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8378

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



8618
8619
8620
8621
8622
8623
8624
8625
8626
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8618

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

Deletes a key value map from an organization.

Parameters:

  • name (String) —

    Required. Name of the key value map. Use the following structure in your request: organizations/org/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



8753
8754
8755
8756
8757
8758
8759
8760
8761
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8753

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

Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. Note: After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior.

Parameters:

  • name (String) —

    Required. Scope as indicated by the URI in which to delete the key value map entry. Use one of the following structures in your request: * organizations/organization/apis/api/keyvaluemaps/keyvaluemap/entries/ entry. * `organizations/`organization`/environments/`environment`/ keyvaluemaps/`keyvaluemap`/entries/`entry * organizations/organization/ keyvaluemaps/keyvaluemap/entries/entry``.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



8829
8830
8831
8832
8833
8834
8835
8836
8837
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8829

def delete_organization_keyvaluemap_entry(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueEntry::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueEntry
  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



9141
9142
9143
9144
9145
9146
9147
9148
9149
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9141

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

DeleteSecurityProfileEnvironmentAssociation removes profile environment association i.e. detaches environment from security profile.

Parameters:

  • name (String) —

    Required. The name of the environment attachment to delete. Format: organizations/org/securityProfiles/profile/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



9456
9457
9458
9459
9460
9461
9462
9463
9464
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9456

def delete_organization_security_profile_environment(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_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



9532
9533
9534
9535
9536
9537
9538
9539
9540
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9532

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



9664
9665
9666
9667
9668
9669
9670
9671
9672
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9664

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



9846
9847
9848
9849
9850
9851
9852
9853
9854
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9846

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, service_account: 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, the routing rules for this deployment and the environment changes to add the deployment will be rolled out 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.

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

    Google Cloud IAM service account. The service account represents the identity of the deployed proxy, and determines what permissions it has. The format must be `ACCOUNT_ID@PROJECT.iam.gserviceaccount.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



4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4889

def deploy_organization_environment_api_revision(name, override: nil, sequenced_rollout: nil, service_account: 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['serviceAccount'] =  unless .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, service_account: 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.

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

    Google Cloud IAM service account. The service account represents the identity of the deployed proxy, and determines what permissions it has. The format must be `ACCOUNT_ID@PROJECT.iam.gserviceaccount.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



7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7140

def deploy_organization_environment_sharedflow_revision(name, override: nil, service_account: 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['serviceAccount'] =  unless .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



5623
5624
5625
5626
5627
5628
5629
5630
5631
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5623

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

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

Expires an API product subscription immediately.

Parameters:

  • name (String) —

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

  • google_cloud_apigee_v1_expire_developer_subscription_request_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3583

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

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

Manages access to a developer app by enabling you to: * Approve or revoke a developer app * Generate a new consumer key and secret for a developer app To approve or revoke a developer app, set the action query parameter to approve or revoke, 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 (approve or revoke) 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



2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2720

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



5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5192

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



5235
5236
5237
5238
5239
5240
5241
5242
5243
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5235

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

#generate_organization_environment_archive_deployment_download_url(name, google_cloud_apigee_v1_generate_download_url_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1GenerateDownloadUrlResponse

Generates a signed URL for downloading the original zip file used to create an Archive Deployment. The URL is only valid for a limited period and should be used within minutes after generation. Each call returns a new upload URL.

Parameters:

  • name (String) —

    Required. The name of the Archive Deployment you want to download.

  • google_cloud_apigee_v1_generate_download_url_request_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1GenerateDownloadUrlRequest) (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



5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5332

def generate_organization_environment_archive_deployment_download_url(name, google_cloud_apigee_v1_generate_download_url_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:generateDownloadUrl', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1GenerateDownloadUrlRequest::Representation
  command.request_object = google_cloud_apigee_v1_generate_download_url_request_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1GenerateDownloadUrlResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1GenerateDownloadUrlResponse
  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_environment_archive_deployment_upload_url(parent, google_cloud_apigee_v1_generate_upload_url_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1GenerateUploadUrlResponse

Generates a signed URL for uploading an Archive zip file to Google Cloud Storage. Once the upload is complete, the signed URL should be passed to CreateArchiveDeployment. When uploading to the generated signed URL, please follow these restrictions: * Source file type should be a zip file. * Source file size should not exceed 1GB limit. * No credentials should be attached - the signed URLs provide access to the target bucket using internal service identity; if credentials were attached, the identity from the credentials would be used, but that identity does not have permissions to upload files to the URL. When making a HTTP PUT request, these two headers need to be specified: * content-type: application/zip * x-goog-content-length-range: 0, 1073741824 And this header SHOULD NOT be specified: * Authorization: Bearer YOUR_TOKEN

Parameters:

  • parent (String) —

    Required. The organization and environment to upload to.

  • google_cloud_apigee_v1_generate_upload_url_request_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1GenerateUploadUrlRequest) (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



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

def generate_organization_environment_archive_deployment_upload_url(parent, google_cloud_apigee_v1_generate_upload_url_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/archiveDeployments:generateUploadUrl', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1GenerateUploadUrlRequest::Representation
  command.request_object = google_cloud_apigee_v1_generate_upload_url_request_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1GenerateUploadUrlResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1GenerateUploadUrlResponse
  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

#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



188
189
190
191
192
193
194
195
196
 
# File 'lib/google/apis/apigee_v1/service.rb', line 188

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



567
568
569
570
571
572
573
574
575
 
# File 'lib/google/apis/apigee_v1/service.rb', line 567

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



1383
1384
1385
1386
1387
1388
1389
1390
1391
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1383

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

Get the Key value entry value for org, env or apis scoped Key value map.

Parameters:

  • name (String) —

    Required. Scope as indicated by the URI in which to fetch the key value map entry/value. Use one of the following structures in your request: * organizations/organization/apis/api/keyvaluemaps/keyvaluemap/entries/ entry. * `organizations/`organization`/environments/`environment`/ keyvaluemaps/`keyvaluemap`/entries/`entry * organizations/organization/ keyvaluemaps/keyvaluemap/entries/entry``.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the 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
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1665

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

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

Gets an API proxy revision. To download the API proxy configuration bundle for the specified revision as a zip file, set the format query parameter to bundle. If you are using curl, specify -o filename.zip to save the output to a file; otherwise, it displays to stdout. Then, develop the API proxy configuration locally and upload the updated API proxy configuration revision, as described in updateApiProxyRevision.

Parameters:

  • name (String) —

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

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

    Format used when downloading the API proxy configuration revision. Set to bundle to download the API proxy configuration revision as a zip file.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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



836
837
838
839
840
841
842
843
844
 
# File 'lib/google/apis/apigee_v1/service.rb', line 836

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



994
995
996
997
998
999
1000
1001
1002
 
# File 'lib/google/apis/apigee_v1/service.rb', line 994

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

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

Gets the details of a rate plan.

Parameters:

  • name (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1169
1170
1171
1172
1173
1174
1175
1176
1177
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1169

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

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

Gets the app profile for the specified app ID.

Parameters:

  • name (String) —

    Required. App ID in the following format: organizations/org/apps/app``

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1886
1887
1888
1889
1890
1891
1892
1893
1894
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1886

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



2050
2051
2052
2053
2054
2055
2056
2057
2058
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2050

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



222
223
224
225
226
227
228
229
230
231
 
# File 'lib/google/apis/apigee_v1/service.rb', line 222

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



2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2312

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



2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2762

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



2925
2926
2927
2928
2929
2930
2931
2932
2933
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2925

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

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

Gets details for a consumer key for a developer app, including the key and secret value, associated API products, and other information.

Parameters:

  • name (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3109
3110
3111
3112
3113
3114
3115
3116
3117
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3109

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



3374
3375
3376
3377
3378
3379
3380
3381
3382
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3374

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

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

Gets the account balance for the developer.

Parameters:

  • name (String) —

    Required. Account balance for the developer. Use the following structure in your request: organizations/org/developers/developer/balance

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2344
2345
2346
2347
2348
2349
2350
2351
2352
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2344

def get_organization_developer_balance(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperBalance::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperBalance
  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_monetization_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperMonetizationConfig

Gets the monetization configuration for the developer.

Parameters:

  • name (String) —

    Required. Monetization configuration for the developer. Use the following structure in your request: organizations/org/developers/developer/ monetizationConfig

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2376
2377
2378
2379
2380
2381
2382
2383
2384
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2376

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

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

Gets details for an API product subscription.

Parameters:

  • name (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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

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

Gets the endpoint attachment.

Parameters:

  • name (String) —

    Required. Name of the endpoint attachment. Use the following structure in your request: organizations/org/endpointAttachments/endpoint_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



3758
3759
3760
3761
3762
3763
3764
3765
3766
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3758

def get_organization_endpoint_attachment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1EndpointAttachment::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1EndpointAttachment
  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



3897
3898
3899
3900
3901
3902
3903
3904
3905
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3897

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



4068
4069
4070
4071
4072
4073
4074
4075
4076
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4068

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



4210
4211
4212
4213
4214
4215
4216
4217
4218
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4210

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

#get_organization_environment_analytic_admin_schemav2(name, disable_cache: nil, type: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Schema

Gets a list of metrics and dimensions that can be used to create analytics queries and reports. Each schema element contains the name of the field, its associated type, and a flag indicating whether it is a standard or custom field.

Parameters:

  • name (String) —

    Required. Path to the schema. Use the following structure in your request: organizations/org/environments/env/analytics/admin/schemav2.

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

    Flag that specifies whether the schema is be read from the database or cache. Set to true to read the schema from the database. Defaults to cache.

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

    Required. Name of the dataset for which you want to retrieve the schema. For example: fact or agg_cus1

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4692

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

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

Gets the details and status of an analytics export job. If the export job is still in progress, its state is set to "running". After the export job has completed successfully, its state is set to "completed". If the export job fails, its state is set to failed.

Parameters:

  • name (String) —

    Required. Resource name of the export to get.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4763
4764
4765
4766
4767
4768
4769
4770
4771
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4763

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



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

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



5148
5149
5150
5151
5152
5153
5154
5155
5156
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5148

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



4925
4926
4927
4928
4929
4930
4931
4932
4933
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4925

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

Gets the specified ArchiveDeployment.

Parameters:

  • name (String) —

    Required. Name of the Archive Deployment in the following format: organizations/org/environments/env/archiveDeployments/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



5409
5410
5411
5412
5413
5414
5415
5416
5417
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5409

def get_organization_environment_archive_deployment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ArchiveDeployment::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ArchiveDeployment
  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



4241
4242
4243
4244
4245
4246
4247
4248
4249
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4241

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



4273
4274
4275
4276
4277
4278
4279
4280
4281
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4273

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



5656
5657
5658
5659
5660
5661
5662
5663
5664
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5656

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 Resource names for the appropriate value for this field.

  • options_requested_policy_version (Fixnum) (defaults to: nil) —

    Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. 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



4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4319

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



5758
5759
5760
5761
5762
5763
5764
5765
5766
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5758

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



5920
5921
5922
5923
5924
5925
5926
5927
5928
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5920

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



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

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

Get the Key value entry value for org, env or apis scoped Key value map.

Parameters:

  • name (String) —

    Required. Scope as indicated by the URI in which to fetch the key value map entry/value. Use one of the following structures in your request: * organizations/organization/apis/api/keyvaluemaps/keyvaluemap/entries/ entry. * `organizations/`organization`/environments/`environment`/ keyvaluemaps/`keyvaluemap`/entries/`entry * organizations/organization/ keyvaluemaps/keyvaluemap/entries/entry``.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6171
6172
6173
6174
6175
6176
6177
6178
6179
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6171

def get_organization_environment_keyvaluemap_entry(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueEntry::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueEntry
  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

Similar to GetStats except that the response is less verbose.

Parameters:

  • name (String) —

    Required. Resource name for which the interactive query will be executed. Use the following format in your request: organizations/org/environments/env/ optimizedStats/dimensions`Dimensions let you view metrics in meaningful groupings, such asapiproxy,target_host. The value ofdimensionsshould be a comma-separated list as shown below:organizations/org/environments/ env/optimizedStats/apiproxy,request_verb`

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

    No longer used by Apigee. Supported for backwards compatibility.

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

    Table name used to query custom aggregate tables. If this parameter is skipped, then Apigee will try to retrieve the data from fact tables which will be expensive.

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

    Filter that enables you to drill-down on specific dimension values.

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

    Maximum number of result items to return. The default and maximum value that can be returned is 14400.

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

    Offset value. 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) —

    No longer used by Apigee. Supported for backwards compatibility.

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

    Required. Comma-separated list of metrics. For example: sum(message_count), sum(error_count)

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

    Routes the query to API Monitoring for the last hour.

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

    Flag that specifies whether the sort order should be ascending or descending. Valid values include 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 in GMT as start~end. For example: 04/15/2017 00:00~05/15/2017 23:59

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

    Granularity of metrics returned. Valid values include: second, minute, hour, day, week, or month.

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

    Top number of results to return. For example, to return the top 5 results, set topk=5.

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

    Flag that specifies whether to list timestamps in ascending (true) or descending (false) order. Apigee recommends setting this value to true if you are using sortby with sort=DESC.

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

    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



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

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



6375
6376
6377
6378
6379
6380
6381
6382
6383
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6375

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



6410
6411
6412
6413
6414
6415
6416
6417
6418
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6410

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

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 sent to the client as a list of urls to JSON files.

Parameters:

  • name (String) —

    Required. Name of the asynchronous query result to get. Must be of the form organizations/org/environments/env/queries/queryId/resulturl.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6443
6444
6445
6446
6447
6448
6449
6450
6451
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6443

def get_organization_environment_query_resulturl(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse
  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



6592
6593
6594
6595
6596
6597
6598
6599
6600
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6592

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



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

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

Get security report 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 security report to get. Must be of the form organizations/org/environments/env/securityReports/reportId``.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6938
6939
6940
6941
6942
6943
6944
6945
6946
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6938

def get_organization_environment_security_report(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityReport::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityReport
  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_security_report_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 as file. 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 security report result to get. Must be of the form organizations/org/environments/env/securityReports/reportId/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



6973
6974
6975
6976
6977
6978
6979
6980
6981
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6973

def get_organization_environment_security_report_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_security_report_result_view(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityReportResultView

After the query is completed, use this API to view the query result when result size is small.

Parameters:

  • name (String) —

    Required. Name of the security report result view to get. Must be of the form organizations/org/environments/env/securityReports/reportId/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



7005
7006
7007
7008
7009
7010
7011
7012
7013
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7005

def get_organization_environment_security_report_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::GoogleCloudApigeeV1SecurityReportResultView::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityReportResultView
  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



7175
7176
7177
7178
7179
7180
7181
7182
7183
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7175

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. You can optionally pass dimensions as path parameters to the stats API. If dimensions are not specified, the metrics are computed on the entire set of data for the given time range.

Parameters:

  • name (String) —

    Required. Resource name for which the interactive query will be executed. Use the following format in your request: organizations/org/environments/env/ stats/dimensions`Dimensions let you view metrics in meaningful groupings, such asapiproxyortarget_host. The value of dimensions should be a comma- separated list, as shown below:organizations/org/environments/env/stats/ apiproxy,request_verb`

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

    No longer used by Apigee. Supported for backwards compatibility.

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

    Table name used to query custom aggregate tables. If this parameter is skipped, then Apigee will try to retrieve the data from fact tables which will be expensive.

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

    Filter that enables you to drill down on specific dimension values.

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

    Maximum number of result items to return. The default and maximum value that can be returned is 14400.

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

    Offset value. 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) —

    No longer used by Apigee. Supported for backwards compatibility.

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

    Comma-separated list of metrics. For example: sum(message_count),sum( error_count)

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

    Routes the query to API Monitoring for the last hour.

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

    Flag that specifies whether the sort order should be ascending or descending. Valid values include: 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 in GMT as start~end. For example: 04/15/2017 00:00~05/15/2017 23:59

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

    Granularity of metrics returned. Valid values include: second, minute, hour, day, week, ormonth.

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

    Top number of results to return. For example, to return the top 5 results, set topk=5.

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

    Flag that specifies whether to list timestamps in ascending (true) or descending (false) order. Apigee recommends that you set this value to true if you are using sortby with sort=DESC.

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

    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



7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7293

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



7409
7410
7411
7412
7413
7414
7415
7416
7417
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7409

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



4351
4352
4353
4354
4355
4356
4357
4358
4359
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4351

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



7546
7547
7548
7549
7550
7551
7552
7553
7554
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7546

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



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

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



7732
7733
7734
7735
7736
7737
7738
7739
7740
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7732

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



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

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

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 security report to get. Must be of the form organizations/org/securityReports/reportId``.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7886
7887
7888
7889
7890
7891
7892
7893
7894
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7886

def get_organization_host_security_report(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityReport::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityReport
  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_security_report_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 security report result to get. Must be of the form organizations/org/securityReports/reportId/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



7921
7922
7923
7924
7925
7926
7927
7928
7929
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7921

def get_organization_host_security_report_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_security_report_result_view(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityReportResultView

After the query is completed, use this API to view the query result when result size is small.

Parameters:

  • name (String) —

    Required. Name of the security report result view to get. Must be of the form organizations/org/securityReports/reportId/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



7953
7954
7955
7956
7957
7958
7959
7960
7961
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7953

def get_organization_host_security_report_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::GoogleCloudApigeeV1SecurityReportResultView::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityReportResultView
  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. You can optionally pass dimensions as path parameters to the stats API. If dimensions are not specified, the metrics are computed on the entire set of data for the given time range.

Parameters:

  • name (String) —

    Required. Resource name for which the interactive query will be executed. Use the following format in your request: organizations/org/hostStats/ dimensions`Dimensions let you view metrics in meaningful groupings, such as apiproxy,target_host. The value of dimensions should be a comma-separated list as shown beloworganizations/org/hostStats/apiproxy,request_verb`

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

    No longer used by Apigee. Supported for backwards compatibility.

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

    Required. Hostname for which the interactive query will be executed.

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

    Flag that enables drill-down on specific dimension values.

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

    Maximum number of result items to return. The default and maximum value that can be returned is 14400.

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

    Offset value. 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) —

    No longer used by Apigee. Supported for backwards compatibility.

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

    Comma-separated list of metrics. For example: sum(message_count),sum( error_count)

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

    Flag that specifies if the sort order should be ascending or descending. Valid 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 in GMT as start~end. For example: 04/15/2017 00:00~05/15/2017 23:59

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

    Granularity of metrics returned. Valid values include: second, minute, hour, day, week, or month.

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

    Top number of results to return. For example, to return the top 5 results, set topk=5.

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

    Flag that specifies whether to list timestamps in ascending (true) or descending (false) order. Apigee recommends that you set this value to true if you are using sortby with sort=DESC.

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

    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



8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8085

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



8199
8200
8201
8202
8203
8204
8205
8206
8207
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8199

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



8409
8410
8411
8412
8413
8414
8415
8416
8417
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8409

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



8513
8514
8515
8516
8517
8518
8519
8520
8521
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8513

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



8649
8650
8651
8652
8653
8654
8655
8656
8657
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8649

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

Get the Key value entry value for org, env or apis scoped Key value map.

Parameters:

  • name (String) —

    Required. Scope as indicated by the URI in which to fetch the key value map entry/value. Use one of the following structures in your request: * organizations/organization/apis/api/keyvaluemaps/keyvaluemap/entries/ entry. * `organizations/`organization`/environments/`environment`/ keyvaluemaps/`keyvaluemap`/entries/`entry * organizations/organization/ keyvaluemaps/keyvaluemap/entries/entry``.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



8864
8865
8866
8867
8868
8869
8870
8871
8872
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8864

def get_organization_keyvaluemap_entry(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueEntry::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueEntry
  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



8938
8939
8940
8941
8942
8943
8944
8945
8946
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8938

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

Similar to GetHostStats except that the response is less verbose.

Parameters:

  • name (String) —

    Required. Resource name for which the interactive query will be executed. Use the following format in your request: organizations/organization_id/ optimizedHostStats/dimensions`Dimensions let you view metrics in meaningful groupings, such asapiproxy,target_host. The value of dimensions should be a comma-separated list as shown below:organizations/org/ optimizedHostStats/apiproxy,request_verb`

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

    No longer used by Apigee. Supported for backwards compatibility.

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

    Required. Hostname for which the interactive query will be executed.

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

    Filter that enables you to drill-down on specific dimension values.

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

    Maximum number of result items to return. The default and maximum value that can be returned is 14400.

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

    Offset value. 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) —

    No longer used by Apigee. Supported for backwards compatibility.

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

    Required. Comma-separated list of metrics. For example: sum(message_count), sum(error_count)

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

    Flag that specifies whether the sort order should be ascending or descending. Valid values include DESC and ASC.

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

    Comma-separated list of columns used to sort the final result.

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

    Required. Time interval for the interactive query. Time range is specified in GMT as start~end. For example: 04/15/2017 00:00~05/15/2017 23:59.

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

    Granularity of metrics returned. Valid values include: second, minute, hour, day, week, or month.

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

    Top number of results to return. For example, to return the top 5 results, set topk=5.

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

    Flag that specifies whether to list timestamps in ascending (true) or descending (false) order. Apigee recommends that you set this value to true if you are using sortby with sort=DESC.

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

    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



9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9056

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

Gets the project ID and region for an Apigee organization.

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



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

def get_organization_project_mapping(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:getProjectMapping', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1OrganizationProjectMapping::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1OrganizationProjectMapping
  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_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



9172
9173
9174
9175
9176
9177
9178
9179
9180
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9172

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

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

Get runtime config for an organization.

Parameters:

  • name (String) —

    Required. Name of the runtime config for the organization in the following format: 'organizations/org/runtimeConfig'.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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

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

GetSecurityProfile gets the specified security profile. Returns NOT_FOUND if security profile is not present for the specified organization.

Parameters:

  • name (String) —

    Required. Security profile in the following format: organizations/org/ securityProfiles/profile`'. Profile may optionally contain revision ID. If revision ID is not provided, the response will contain latest revision by default. Example: organizations/testOrg/securityProfiles/testProfile@5

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



9274
9275
9276
9277
9278
9279
9280
9281
9282
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9274

def get_organization_security_profile(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityProfile::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityProfile
  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



9563
9564
9565
9566
9567
9568
9569
9570
9571
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9563

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

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

Gets a revision of a shared flow. To download the shared flow configuration bundle for the specified revision as a zip file, set the format query parameter to bundle. If you are using curl, specify -o filename.zip to save the output to a file; otherwise, it displays to stdout. Then, develop the shared flow configuration locally and upload the updated sharedFlow configuration revision, as described in updateSharedFlowRevision.

Parameters:

  • name (String) —

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

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

    Specify bundle to export the contents of the shared flow bundle. Otherwise, the bundle metadata is returned.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9705

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



9877
9878
9879
9880
9881
9882
9883
9884
9885
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9877

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



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

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



600
601
602
603
604
605
606
607
608
609
 
# File 'lib/google/apis/apigee_v1/service.rb', line 600

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



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

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_keyvaluemap_entries(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListKeyValueEntriesResponse

Lists key value entries for key values maps scoped to an organization, environment, or API proxy.

Parameters:

  • parent (String) —

    Required. Scope as indicated by the URI in which to list key value maps. Use ** one** of the following structures in your request: * organizations/ organization/apis/api/keyvaluemaps/keyvaluemap. * `organizations/` organization`/environments/`environment`/keyvaluemaps/`keyvaluemap * organizations/organization/keyvaluemaps/keyvaluemap``.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Maximum number of key value entries to return. If unspecified, at most 100 entries will be returned.

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

    Optional. Page token. If provides, must be a valid key value entry returned from a previous call that can be used 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



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

def list_organization_api_keyvaluemap_entries(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/entries', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListKeyValueEntriesResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListKeyValueEntriesResponse
  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_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



1856
1857
1858
1859
1860
1861
1862
1863
1864
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1856

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



1025
1026
1027
1028
1029
1030
1031
1032
1033
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1025

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

#list_organization_apiproduct_rateplans(parent, count: nil, expand: nil, order_by: nil, start_key: nil, state: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListRatePlansResponse

Lists all the rate plans for an API product.

Parameters:

  • parent (String) —

    Required. Name of the API product. Use the following structure in your request: organizations/org/apiproducts/apiproduct`Useorganizations/org/ apiproducts/-` to return rate plans for all API products within the organization.

  • count (Fixnum) (defaults to: nil) —

    Number of rate plans to return in the API call. Use with the startKey parameter to provide more targeted filtering. The maximum limit is 1000. Defaults to 100.

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

    Flag that specifies whether to expand the results. Set to true to get expanded details about each API. Defaults to false.

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

    Name of the attribute used for sorting. Valid values include: * name: Name of the rate plan. * state: State of the rate plan (DRAFT, PUBLISHED). * startTime: Time when the rate plan becomes active. * endTime: Time when the rate plan expires. Note: Not supported by Apigee at this time.

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

    Name of the rate plan from which to start displaying the list of rate plans. If omitted, the list starts from the first item. For example, to view the rate plans from 51-150, set the value of startKey to the name of the 51st rate plan and set the value of count to 100.

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

    State of the rate plans (DRAFT, PUBLISHED) that you want to display.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1221

def list_organization_apiproduct_rateplans(parent, count: nil, expand: nil, order_by: nil, start_key: nil, state: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/rateplans', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListRatePlansResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListRatePlansResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['count'] = count unless count.nil?
  command.query['expand'] = expand unless expand.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['startKey'] = start_key unless start_key.nil?
  command.query['state'] = state unless state.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_apiproducts(parent, attributename: nil, attributevalue: nil, count: nil, expand: nil, start_key: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiProductsResponse

Lists all API product names for an organization. Filter the list by passing an attributename and attibutevalue. The maximum number of API products returned is 1000. You can paginate the list of API products returned using the startKey and count query parameters.

Parameters:

  • parent (String) —

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

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

    Name of the attribute used to filter the search.

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

    Value of the attribute used to filter the search.

  • count (Fixnum) (defaults to: nil) —

    Enter the number of API products you want returned in the API call. The limit is 1000.

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

    Flag that specifies whether to expand the results. Set to true to get expanded details about each API.

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

    Gets a list of API products starting with a specific API product in the list. For example, if you're returning 50 API products at a time (using the count query parameter), you can view products 50-99 by entering the name of the 50th API product in the first API (without using startKey). Product name is case sensitive.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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



1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1419

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



1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1940

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



2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2086

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



2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2160

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



2956
2957
2958
2959
2960
2961
2962
2963
2964
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2956

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



2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2814

def list_organization_developer_apps(parent, count: nil, expand: nil, shallow_expand: nil, start_key: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/apps', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeveloperAppsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeveloperAppsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['count'] = count unless count.nil?
  command.query['expand'] = expand unless expand.nil?
  command.query['shallowExpand'] = shallow_expand unless shallow_expand.nil?
  command.query['startKey'] = start_key unless start_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Returns a list of all developer attributes.

Parameters:

  • parent (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3406
3407
3408
3409
3410
3411
3412
3413
3414
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3406

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

#list_organization_developer_subscriptions(parent, count: nil, start_key: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse

Lists all API product subscriptions for a developer.

Parameters:

  • parent (String) —

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

  • count (Fixnum) (defaults to: nil) —

    Number of API product subscriptions to return in the API call. Use with startKey to provide more targeted filtering. Defaults to 100. The maximum limit is 1000.

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

    Name of the API product subscription from which to start displaying the list of subscriptions. If omitted, the list starts from the first item. For example, to view the API product subscriptions from 51-150, set the value of startKey to the name of the 51st subscription and set the value of count to 100.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3657

def list_organization_developer_subscriptions(parent, count: nil, start_key: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/subscriptions', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['count'] = count unless count.nil?
  command.query['startKey'] = start_key unless start_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_developers(parent, app: nil, count: nil, expand: nil, ids: nil, include_company: nil, start_key: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListOfDevelopersResponse

Lists all developers in an organization by email address. By default, the response does not include company developers. Set the includeCompany query parameter to true to include company developers. Note: A maximum of 1000 developers are returned in the response. You paginate the list of developers returned using the startKey and count query parameters.

Parameters:

  • parent (String) —

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

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

    Optional. List only Developers that are associated with the app. Note that start_key, count are not applicable for this filter criteria.

  • count (Fixnum) (defaults to: nil) —

    Optional. Number of developers to return in the API call. Use with the startKey parameter to provide more targeted filtering. The limit is 1000.

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

    Specifies whether to expand the results. Set to true to expand the results. This query parameter is not valid if you use the count or startKey query parameters.

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

    Optional. List of IDs to include, separated by commas.

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

    Flag that specifies whether to include company details in the response.

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

    Note: Must be used in conjunction with the count parameter. Email address of the developer from which to start displaying the list of developers. For example, if the an unfiltered list returns: westley@example.com fezzik@example.com buttercup@example.com and your startKey is fezzik@ example.com, the list returned will be fezzik@example.com buttercup@ example.com

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2432

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_endpoint_attachments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEndpointAttachmentsResponse

Lists the endpoint attachments in an organization.

Parameters:

  • parent (String) —

    Required. Name of the organization for which to list endpoint attachments. Use the following structure in your request: organizations/org``

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Maximum number of endpoint attachments to return. If unspecified, at most 25 attachments will be returned.

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

    Optional. Page token, returned from a previous ListEndpointAttachments 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



3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3795

def list_organization_endpoint_attachments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/endpointAttachments', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEndpointAttachmentsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEndpointAttachmentsResponse
  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_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



4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4105

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



3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3933

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



4795
4796
4797
4798
4799
4800
4801
4802
4803
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4795

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



4826
4827
4828
4829
4830
4831
4832
4833
4834
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4826

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



5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5114

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_archive_deployments(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListArchiveDeploymentsResponse

Lists the ArchiveDeployments in the specified Environment.

Parameters:

  • parent (String) —

    Required. Name of the Environment for which to list Archive Deployments in the format: organizations/org/environments/env``.

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

    Optional. An optional query used to return a subset of Archive Deployments using the semantics defined in https://google.aip.dev/160.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Maximum number of Archive Deployments to return. If unspecified, at most 25 deployments will be returned.

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

    Optional. Page token, returned from a previous ListArchiveDeployments 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



5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5449

def list_organization_environment_archive_deployments(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/archiveDeployments', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListArchiveDeploymentsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListArchiveDeploymentsResponse
  command.params['parent'] = parent unless parent.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_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



5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5556

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_keyvaluemap_entries(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListKeyValueEntriesResponse

Lists key value entries for key values maps scoped to an organization, environment, or API proxy.

Parameters:

  • parent (String) —

    Required. Scope as indicated by the URI in which to list key value maps. Use ** one** of the following structures in your request: * organizations/ organization/apis/api/keyvaluemaps/keyvaluemap. * `organizations/` organization`/environments/`environment`/keyvaluemaps/`keyvaluemap * organizations/organization/keyvaluemaps/keyvaluemap``.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Maximum number of key value entries to return. If unspecified, at most 100 entries will be returned.

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

    Optional. Page token. If provides, must be a valid key value entry returned from a previous call that can be used 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



6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6212

def list_organization_environment_keyvaluemap_entries(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/entries', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListKeyValueEntriesResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListKeyValueEntriesResponse
  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_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



6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6489

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



6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6823

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



6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6787

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_security_reports(parent, dataset: nil, from: nil, page_size: nil, page_token: nil, status: nil, submitted_by: nil, to: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListSecurityReportsResponse

Return a list of Security Reports

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 security reports that created after this date time. Time must be in ISO date-time format like '2011-12-03T10:15:30Z'.

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of security report to return in the list response.

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

    Token returned from the previous list response to fetch the next page.

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

    Filter response list by security reports 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 security reports 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



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

def list_organization_environment_security_reports(parent, dataset: nil, from: nil, page_size: nil, page_token: nil, status: nil, submitted_by: nil, to: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/securityReports', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListSecurityReportsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListSecurityReportsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['dataset'] = dataset unless dataset.nil?
  command.query['from'] = from unless from.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.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_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



7090
7091
7092
7093
7094
7095
7096
7097
7098
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7090

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



7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7586

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



7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7810

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_host_security_reports(parent, dataset: nil, envgroup_hostname: nil, from: nil, page_size: nil, page_token: nil, status: nil, submitted_by: nil, to: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListSecurityReportsResponse

Return a list of Security Reports 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 security reports that created after this date time. Time must be in ISO date-time format like '2011-12-03T10:15:30Z'.

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of security report to return in the list response.

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

    Token returned from the previous list response to fetch the next page.

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

    Filter response list by security report 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 security reports 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



8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8001

def list_organization_host_security_reports(parent, dataset: nil, envgroup_hostname: nil, from: nil, page_size: nil, page_token: nil, status: nil, submitted_by: nil, to: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/hostSecurityReports', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListSecurityReportsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListSecurityReportsResponse
  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['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.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



8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8446

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



8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8686

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



8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8236

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_keyvaluemap_entries(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListKeyValueEntriesResponse

Lists key value entries for key values maps scoped to an organization, environment, or API proxy.

Parameters:

  • parent (String) —

    Required. Scope as indicated by the URI in which to list key value maps. Use ** one** of the following structures in your request: * organizations/ organization/apis/api/keyvaluemaps/keyvaluemap. * `organizations/` organization`/environments/`environment`/keyvaluemaps/`keyvaluemap * organizations/organization/keyvaluemaps/keyvaluemap``.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Maximum number of key value entries to return. If unspecified, at most 100 entries will be returned.

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

    Optional. Page token. If provides, must be a valid key value entry returned from a previous call that can be used 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



8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8905

def list_organization_keyvaluemap_entries(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/entries', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListKeyValueEntriesResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListKeyValueEntriesResponse
  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



8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8981

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



9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9205

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_security_profile_revisions(name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse

ListSecurityProfileRevisions lists all the revisions of the security profile.

Parameters:

  • name (String) —

    Required. For a specific profile, list all the revisions. Format: organizations/org/securityProfiles/profile``

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of profile revisions to return. The service may return fewer than this value. If unspecified, at most 50 revisions will be returned.

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

    A page token, received from a previous ListSecurityProfileRevisions call. Provide this to retrieve the subsequent 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



9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9351

def list_organization_security_profile_revisions(name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:listRevisions', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse
  command.params['name'] = name unless name.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_security_profiles(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListSecurityProfilesResponse

ListSecurityProfiles lists all the security profiles associated with the org including attached and unattached profiles.

Parameters:

  • parent (String) —

    Required. For a specific organization, list of all the security profiles. Format: organizations/org``

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of profiles to return. The service may return fewer than this value. If unspecified, at most 50 profiles will be returned.

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

    A page token, received from a previous ListSecurityProfiles call. Provide this to retrieve the subsequent 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



9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9312

def list_organization_security_profiles(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/securityProfiles', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListSecurityProfilesResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListSecurityProfilesResponse
  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_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



9631
9632
9633
9634
9635
9636
9637
9638
9639
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9631

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



9781
9782
9783
9784
9785
9786
9787
9788
9789
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9781

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



9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9598

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



9908
9909
9910
9911
9912
9913
9914
9915
9916
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9908

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



359
360
361
362
363
364
365
366
367
 
# File 'lib/google/apis/apigee_v1/service.rb', line 359

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_api(name, google_cloud_apigee_v1_api_proxy_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy

Updates an existing API proxy.

Parameters:

  • name (String) —

    Required. API proxy to update in the following format: organizations/org/ apis/api``

  • google_cloud_apigee_v1_api_proxy_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The list of fields to update.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1455

def patch_organization_api(name, google_cloud_apigee_v1_api_proxy_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::GoogleCloudApigeeV1ApiProxy::Representation
  command.request_object = google_cloud_apigee_v1_api_proxy_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy
  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_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



2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2122

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



3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3969

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_archive_deployment(name, google_cloud_apigee_v1_archive_deployment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ArchiveDeployment

Updates an existing ArchiveDeployment. Labels can modified but most of the other fields are not modifiable.

Parameters:

  • name (String) —

    Name of the Archive Deployment in the following format: organizations/org/ environments/env/archiveDeployments/id``.

  • google_cloud_apigee_v1_archive_deployment_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1ArchiveDeployment) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The 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



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

def patch_organization_environment_archive_deployment(name, google_cloud_apigee_v1_archive_deployment_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::GoogleCloudApigeeV1ArchiveDeployment::Representation
  command.request_object = google_cloud_apigee_v1_archive_deployment_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ArchiveDeployment::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ArchiveDeployment
  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



7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7625

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_instance(name, google_cloud_apigee_v1_instance_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleLongrunningOperation

Updates an Apigee runtime instance. You can update the fields described in NodeConfig. No other fields will be updated. 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``.

  • google_cloud_apigee_v1_instance_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1Instance) (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



8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8274

def patch_organization_instance(name, google_cloud_apigee_v1_instance_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::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['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



9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9940

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



9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9975

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



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

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



8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8310

def report_organization_instance_status(instance, google_cloud_apigee_v1_report_instance_status_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+instance}:reportStatus', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ReportInstanceStatusRequest::Representation
  command.request_object = google_cloud_apigee_v1_report_instance_status_request_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ReportInstanceStatusResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ReportInstanceStatusResponse
  command.params['instance'] = instance unless instance.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_organization_addons(org, google_cloud_apigee_v1_set_addons_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleLongrunningOperation

Configures the add-ons for the Apigee organization. The existing add-on configuration will be fully replaced.

Parameters:

  • org (String) —

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

  • google_cloud_apigee_v1_set_addons_request_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1SetAddonsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/google/apis/apigee_v1/service.rb', line 392

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

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

Sets the status of a developer. A developer is active by default. If you set a developer's status to inactive, the API keys assigned to the developer apps are no longer valid even though the API keys are set to approved. Inactive developers can still sign in to the developer portal and create apps; however, any new API keys generated during app creation won't work. To set the status of a developer, set the action query parameter to active or inactive, and the Content-Type header to application/octet-stream. If successful, the API call returns the following HTTP status code: 204 No Content

Parameters:

  • name (String) —

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

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

    Status of the developer. Valid values are active and inactive.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2479

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



4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4388

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



434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/google/apis/apigee_v1/service.rb', line 434

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



4423
4424
4425
4426
4427
4428
4429
4430
4431
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4423

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



635
636
637
638
639
640
641
642
643
644
645
 
# File 'lib/google/apis/apigee_v1/service.rb', line 635

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



4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4458

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, the environment group routing rules corresponding to this deployment will be removed 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



4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4971

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



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

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



4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4492

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



469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/google/apis/apigee_v1/service.rb', line 469

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



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

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



1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1821

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



928
929
930
931
932
933
934
935
936
937
938
 
# File 'lib/google/apis/apigee_v1/service.rb', line 928

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



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

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

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

Updates an existing rate plan.

Parameters:

  • name (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1258

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

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

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

Parameters:

  • name (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2520

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



2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2859

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



2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2994

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

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

Approves or revokes the consumer key for an API product. After a consumer key is approved, the app can use it to access APIs. A consumer key that is revoked or pending cannot be used to access an API. Any access tokens associated with a revoked consumer key will remain active. However, Apigee checks the status of the consumer key and if set to revoked will not allow access to the API.

Parameters:

  • name (String) —

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

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

    Approve or revoke the consumer key by setting this value to approve or revoke, respectively.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3265

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. The Content-Type header must be set to application/ octet-stream.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3188

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



3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3444

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_developer_monetization_config(name, google_cloud_apigee_v1_developer_monetization_config_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperMonetizationConfig

Updates the monetization configuration for the developer.

Parameters:

  • name (String) —

    Required. Monetization configuration for the developer. Use the following structure in your request: organizations/org/developers/developer/ monetizationConfig

  • google_cloud_apigee_v1_developer_monetization_config_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperMonetizationConfig) (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



2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2555

def update_organization_developer_monetization_config(name, google_cloud_apigee_v1_developer_monetization_config_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperMonetizationConfig::Representation
  command.request_object = google_cloud_apigee_v1_developer_monetization_config_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperMonetizationConfig::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperMonetizationConfig
  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. Note: Both PUT and POST methods are supported for updating an existing environment.

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



4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4531

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



4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4570

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. Note: Both PUT and POST methods are supported for updating an existing environment.

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



4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4611

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



5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5990

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



6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6626

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



6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6864

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



7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7443

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



4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4649

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



9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9238

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



9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9746

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