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:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://apigee.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ApigeeService

Returns a new instance of ApigeeService.



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

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        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.



43
44
45
 
# File 'lib/google/apis/apigee_v1/service.rb', line 43

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.



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

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



10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
 
# File 'lib/google/apis/apigee_v1/service.rb', line 10141

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



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

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



6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6730

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



789
790
791
792
793
794
795
796
797
798
799
 
# File 'lib/google/apis/apigee_v1/service.rb', line 789

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



2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2942

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



3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3330

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

#batch_organization_environment_security_incident_update(parent, google_cloud_apigee_v1_batch_update_security_incidents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse

BatchUpdateSecurityIncident updates multiple existing security incidents.

Parameters:

  • parent (String) —

    Optional. The parent resource shared by all security incidents being updated. If this is set, the parent field in the UpdateSecurityIncidentRequest messages must either be empty or match this field.

  • google_cloud_apigee_v1_batch_update_security_incidents_request_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest) (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



8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8277

def batch_organization_environment_security_incident_update(parent, google_cloud_apigee_v1_batch_update_security_incidents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/securityIncidents:batchUpdate', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest::Representation
  command.request_object = google_cloud_apigee_v1_batch_update_security_incidents_request_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse
  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

#batch_organization_security_assessment_result_compute(name, google_cloud_apigee_v1_batch_compute_security_assessment_results_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse

Compute RAV2 security scores for a set of resources.

Parameters:

  • name (String) —

    Required. Name of the organization for which the score needs to be computed in the following format: organizations/org/securityAssessmentResults

  • google_cloud_apigee_v1_batch_compute_security_assessment_results_request_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequest) (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



10904
10905
10906
10907
10908
10909
10910
10911
10912
10913
10914
 
# File 'lib/google/apis/apigee_v1/service.rb', line 10904

def batch_organization_security_assessment_result_compute(name, google_cloud_apigee_v1_batch_compute_security_assessment_results_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:batchCompute', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequest::Representation
  command.request_object = google_cloud_apigee_v1_batch_compute_security_assessment_results_request_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse
  command.params['name'] = name unless name.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



11159
11160
11161
11162
11163
11164
11165
11166
11167
11168
11169
 
# File 'lib/google/apis/apigee_v1/service.rb', line 11159

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



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

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



580
581
582
583
584
585
586
587
588
589
590
 
# File 'lib/google/apis/apigee_v1/service.rb', line 580

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



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

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



1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1598

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. Note: Supported for Apigee hybrid 1.8.x and higher.

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



1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1668

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



838
839
840
841
842
843
844
845
846
847
848
 
# File 'lib/google/apis/apigee_v1/service.rb', line 838

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



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

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

Creates an AppGroup. Once created, user can register apps under the AppGroup to obtain secret key and password. At creation time, the AppGroup's state is set as active.

Parameters:

  • parent (String) —

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

  • google_cloud_apigee_v1_app_group_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup) (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



2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2010

def create_organization_appgroup(parent, google_cloud_apigee_v1_app_group_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/appgroups', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup::Representation
  command.request_object = google_cloud_apigee_v1_app_group_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup
  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_appgroup_app(parent, google_cloud_apigee_v1_app_group_app_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp

Creates an app and associates it with an AppGroup. This API associates the AppGroup 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.

Parameters:

  • parent (String) —

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

  • google_cloud_apigee_v1_app_group_app_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp) (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 create_organization_appgroup_app(parent, google_cloud_apigee_v1_app_group_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::GoogleCloudApigeeV1AppGroupApp::Representation
  command.request_object = google_cloud_apigee_v1_app_group_app_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp
  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_appgroup_app_key(parent, google_cloud_apigee_v1_app_group_app_key_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey

Creates a custom consumer key and secret for a AppGroup 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 ProductizeAppGroupAppKey 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 DeleteAppGroupAppKey API.

Parameters:

  • parent (String) —

    Required. Parent of the AppGroup app key. Use the following structure in your request: organizations/org/appgroups/app_group_name/apps/app/keys

  • google_cloud_apigee_v1_app_group_app_key_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

def create_organization_appgroup_app_key(parent, google_cloud_apigee_v1_app_group_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::GoogleCloudApigeeV1AppGroupAppKey::Representation
  command.request_object = google_cloud_apigee_v1_app_group_app_key_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey
  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



2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2725

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



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

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



3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3369

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. Note: All keys start out with status=approved, even if status=revoked is passed when the key is created. To revoke a key, use the UpdateDeveloperAppKey API.

Parameters:

  • parent (String) —

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

  • 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



3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3780

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. Note: All keys start out with status=approved, even if status=revoked is passed when the key is created. To revoke a key, use the UpdateDeveloperAppKey API.

Parameters:

  • parent (String) —

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

  • 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



4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4052

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



4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4292

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. ID must start with a lowercase letter followed by up to 31 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. The minimum length is 2.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4438

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

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



4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4577

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



4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4785

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.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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



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

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



5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5993

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



6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6251

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



6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6833

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



6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6959

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



7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7167

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. Note: Supported for Apigee hybrid 1.8.x and higher.

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



7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7237

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



7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7523

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



7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7710

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



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

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_action(parent, google_cloud_apigee_v1_security_action_object = nil, security_action_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityAction

CreateSecurityAction creates a SecurityAction.

Parameters:

  • parent (String) —

    Required. The organization and environment that this SecurityAction applies to. Format: organizations/org/environments/env

  • google_cloud_apigee_v1_security_action_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityAction) (defaults to: nil)
  • security_action_id (String) (defaults to: nil) —

    Required. The ID to use for the SecurityAction, which will become the final component of the action's resource name. This value should be 0-61 characters, and valid format is (^a-z?$).

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8087

def create_organization_environment_security_action(parent, google_cloud_apigee_v1_security_action_object = nil, security_action_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/securityActions', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityAction::Representation
  command.request_object = google_cloud_apigee_v1_security_action_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityAction::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityAction
  command.params['parent'] = parent unless parent.nil?
  command.query['securityActionId'] = security_action_id unless security_action_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_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



8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8432

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



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

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



9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9075

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



9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9257

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



9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9446

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



9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9728

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



9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9940

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



10075
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085
 
# File 'lib/google/apis/apigee_v1/service.rb', line 10075

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



10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
10189
 
# File 'lib/google/apis/apigee_v1/service.rb', line 10179

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



10315
10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
 
# File 'lib/google/apis/apigee_v1/service.rb', line 10315

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. Note: Supported for Apigee hybrid 1.8.x and higher.

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



10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
 
# File 'lib/google/apis/apigee_v1/service.rb', line 10385

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



10740
10741
10742
10743
10744
10745
10746
10747
10748
10749
10750
 
# File 'lib/google/apis/apigee_v1/service.rb', line 10740

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

CreateSecurityProfile create a new custom security profile.

Parameters:

  • parent (String) —

    Required. Name of organization. Format: organizations/org

  • google_cloud_apigee_v1_security_profile_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityProfile) (defaults to: nil)
  • security_profile_id (String) (defaults to: nil) —

    Required. The ID to use for the SecurityProfile, which will become the final component of the action's resource name. This value should be 1-63 characters and validated by "(^a-z?$)".

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
 
# File 'lib/google/apis/apigee_v1/service.rb', line 10941

def create_organization_security_profile(parent, google_cloud_apigee_v1_security_profile_object = nil, security_profile_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/securityProfiles', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityProfile::Representation
  command.request_object = google_cloud_apigee_v1_security_profile_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityProfile::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityProfile
  command.params['parent'] = parent unless parent.nil?
  command.query['securityProfileId'] = security_profile_id unless security_profile_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_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



11194
11195
11196
11197
11198
11199
11200
11201
11202
11203
11204
 
# File 'lib/google/apis/apigee_v1/service.rb', line 11194

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



11268
11269
11270
11271
11272
11273
11274
11275
11276
11277
11278
11279
11280
 
# File 'lib/google/apis/apigee_v1/service.rb', line 11268

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

Creates a new API category.

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_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategory) (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



11585
11586
11587
11588
11589
11590
11591
11592
11593
11594
11595
 
# File 'lib/google/apis/apigee_v1/service.rb', line 11585

def create_organization_site_apicategory(parent, google_cloud_apigee_v1_api_category_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::GoogleCloudApigeeV1ApiCategory::Representation
  command.request_object = google_cloud_apigee_v1_api_category_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategoryResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategoryResponse
  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_site_apidoc(parent, google_cloud_apigee_v1_api_doc_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocResponse

Creates a new catalog item.

Parameters:

  • parent (String) —

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

  • google_cloud_apigee_v1_api_doc_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDoc) (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



11746
11747
11748
11749
11750
11751
11752
11753
11754
11755
11756
 
# File 'lib/google/apis/apigee_v1/service.rb', line 11746

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



4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4257

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



6998
6999
7000
7001
7002
7003
7004
7005
7006
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6998

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 (Subscription or Pay-as-you-go), a soft-deletion is performed. The organization can be restored within the soft-deletion period, which is specified using the retention field in the request or by filing a support ticket with Apigee. During the data retention period specified in the request, the Apigee organization cannot be recreated in the same Google Cloud project. IMPORTANT: The default data retention setting for this operation is 7 days. To permanently delete the organization in 24 hours, set the retention parameter to MINIMUM.

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. Note: During the data retention period specified using this field, the Apigee organization cannot be recreated in the same Google Cloud project.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



162
163
164
165
166
167
168
169
170
171
 
# File 'lib/google/apis/apigee_v1/service.rb', line 162

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



613
614
615
616
617
618
619
620
621
 
# File 'lib/google/apis/apigee_v1/service.rb', line 613

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



1429
1430
1431
1432
1433
1434
1435
1436
1437
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1429

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



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

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. Notes: * 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. * Supported for Apigee hybrid 1.8.x and higher.

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



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

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



1861
1862
1863
1864
1865
1866
1867
1868
1869
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1861

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



878
879
880
881
882
883
884
885
886
 
# File 'lib/google/apis/apigee_v1/service.rb', line 878

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



1039
1040
1041
1042
1043
1044
1045
1046
1047
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1039

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



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

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

Deletes an AppGroup. All app and API keys associations with the AppGroup are also removed. Warning: This API will permanently delete the AppGroup and related artifacts. Note: The delete operation is asynchronous. The AppGroup 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. Name of the AppGroup. Use the following structure in your request: organizations/org/appgroups/app_group_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



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

def delete_organization_appgroup(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup
  command.params['name'] = name unless name.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_appgroup_app(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp

Deletes an AppGroup app. Note: The delete operation is asynchronous. The AppGroup 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 AppGroup app. Use the following structure in your request: organizations/org/appgroups/app_group_name/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



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

def delete_organization_appgroup_app(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp
  command.params['name'] = name unless name.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_appgroup_app_key(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey

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.

Parameters:

  • name (String) —

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



2434
2435
2436
2437
2438
2439
2440
2441
2442
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2434

def delete_organization_appgroup_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::GoogleCloudApigeeV1AppGroupAppKey::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey
  command.params['name'] = name unless name.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_appgroup_app_key_apiproduct(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey

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

    Required. Parent of the AppGroup app key. Use the following structure in your request: organizations/org/appgroups/app_group_name/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



2540
2541
2542
2543
2544
2545
2546
2547
2548
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2540

def delete_organization_appgroup_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::GoogleCloudApigeeV1AppGroupAppKey::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey
  command.params['name'] = name unless name.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



2759
2760
2761
2762
2763
2764
2765
2766
2767
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2759

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



3017
3018
3019
3020
3021
3022
3023
3024
3025
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3017

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



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

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



3633
3634
3635
3636
3637
3638
3639
3640
3641
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3633

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



3819
3820
3821
3822
3823
3824
3825
3826
3827
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3819

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



3968
3969
3970
3971
3972
3973
3974
3975
3976
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3968

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



4086
4087
4088
4089
4090
4091
4092
4093
4094
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4086

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



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

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



4611
4612
4613
4614
4615
4616
4617
4618
4619
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4611

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



4818
4819
4820
4821
4822
4823
4824
4825
4826
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4818

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



4959
4960
4961
4962
4963
4964
4965
4966
4967
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4959

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



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

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



6284
6285
6286
6287
6288
6289
6290
6291
6292
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6284

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



6506
6507
6508
6509
6510
6511
6512
6513
6514
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6506

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



6867
6868
6869
6870
6871
6872
6873
6874
6875
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6867

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



7029
7030
7031
7032
7033
7034
7035
7036
7037
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7029

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



7200
7201
7202
7203
7204
7205
7206
7207
7208
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7200

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. Notes: * 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. * Supported for Apigee hybrid 1.8.x and higher.

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



7278
7279
7280
7281
7282
7283
7284
7285
7286
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7278

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



7744
7745
7746
7747
7748
7749
7750
7751
7752
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7744

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



7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7893

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



8973
8974
8975
8976
8977
8978
8979
8980
8981
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8973

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



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

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



9762
9763
9764
9765
9766
9767
9768
9769
9770
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9762

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



9973
9974
9975
9976
9977
9978
9979
9980
9981
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9973

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



10213
10214
10215
10216
10217
10218
10219
10220
10221
 
# File 'lib/google/apis/apigee_v1/service.rb', line 10213

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



10348
10349
10350
10351
10352
10353
10354
10355
10356
 
# File 'lib/google/apis/apigee_v1/service.rb', line 10348

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. Notes: * 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. * Supported for Apigee hybrid 1.8.x and higher.

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



10426
10427
10428
10429
10430
10431
10432
10433
10434
 
# File 'lib/google/apis/apigee_v1/service.rb', line 10426

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



10773
10774
10775
10776
10777
10778
10779
10780
10781
 
# File 'lib/google/apis/apigee_v1/service.rb', line 10773

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

DeleteSecurityProfile delete a profile with all its revisions.

Parameters:

  • name (String) —

    Required. Name of profile. Format: organizations/org/securityProfiles/ profile

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



10975
10976
10977
10978
10979
10980
10981
10982
10983
 
# File 'lib/google/apis/apigee_v1/service.rb', line 10975

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



11228
11229
11230
11231
11232
11233
11234
11235
11236
 
# File 'lib/google/apis/apigee_v1/service.rb', line 11228

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



11304
11305
11306
11307
11308
11309
11310
11311
11312
 
# File 'lib/google/apis/apigee_v1/service.rb', line 11304

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



11436
11437
11438
11439
11440
11441
11442
11443
11444
 
# File 'lib/google/apis/apigee_v1/service.rb', line 11436

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

Deletes an API category.

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



11618
11619
11620
11621
11622
11623
11624
11625
11626
 
# File 'lib/google/apis/apigee_v1/service.rb', line 11618

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::GoogleCloudApigeeV1DeleteResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeleteResponse
  command.params['name'] = name unless name.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_apidoc(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeleteResponse

Deletes a catalog item.

Parameters:

  • name (String) —

    Required. Name of the catalog item. Use the following structure in your request: organizations/org/sites/site/apidocs/apidoc``

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



11779
11780
11781
11782
11783
11784
11785
11786
11787
 
# File 'lib/google/apis/apigee_v1/service.rb', line 11779

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



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

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



8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8735

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



6763
6764
6765
6766
6767
6768
6769
6770
6771
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6763

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

#disable_organization_environment_security_action(name, google_cloud_apigee_v1_disable_security_action_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityAction

Disable a SecurityAction. The state of the SecurityAction after disabling is DISABLED. DisableSecurityAction can be called on SecurityActions in the state ENABLED; SecurityActions in a different state (including DISABLED) return an error.

Parameters:

  • name (String) —

    Required. The name of the SecurityAction to disable. Format: organizations/ org/environments/env/securityActions/security_action

  • google_cloud_apigee_v1_disable_security_action_request_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1DisableSecurityActionRequest) (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



8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8125

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

#enable_organization_environment_security_action(name, google_cloud_apigee_v1_enable_security_action_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityAction

Enable a SecurityAction. The state of the SecurityAction after enabling is ENABLED. EnableSecurityAction can be called on SecurityActions in the state DISABLED; SecurityActions in a different state (including `ENABLED) return an error.

Parameters:

  • name (String) —

    Required. The name of the SecurityAction to enable. Format: organizations/org /environments/env/securityActions/security_action

  • google_cloud_apigee_v1_enable_security_action_request_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnableSecurityActionRequest) (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



8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8162

def enable_organization_environment_security_action(name, google_cloud_apigee_v1_enable_security_action_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:enable', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnableSecurityActionRequest::Representation
  command.request_object = google_cloud_apigee_v1_enable_security_action_request_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityAction::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityAction
  command.params['name'] = name unless name.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



4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4327

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



3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3460

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



6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6177

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



6220
6221
6222
6223
6224
6225
6226
6227
6228
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6220

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



6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6317

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



6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6361

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



196
197
198
199
200
201
202
203
204
 
# File 'lib/google/apis/apigee_v1/service.rb', line 196

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



644
645
646
647
648
649
650
651
652
 
# File 'lib/google/apis/apigee_v1/service.rb', line 644

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



1460
1461
1462
1463
1464
1465
1466
1467
1468
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1460

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 a key value map scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.

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



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

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



1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1900

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



913
914
915
916
917
918
919
920
921
 
# File 'lib/google/apis/apigee_v1/service.rb', line 913

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



1071
1072
1073
1074
1075
1076
1077
1078
1079
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1071

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



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

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



2611
2612
2613
2614
2615
2616
2617
2618
2619
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2611

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

Returns the AppGroup details for the provided AppGroup name in the request URI.

Parameters:

  • name (String) —

    Required. Name of the AppGroup. Use the following structure in your request: organizations/org/appgroups/app_group_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



2079
2080
2081
2082
2083
2084
2085
2086
2087
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2079

def get_organization_appgroup(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup
  command.params['name'] = name unless name.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_appgroup_app(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp

Returns the details for an AppGroup app.

Parameters:

  • name (String) —

    Required. Name of the AppGroup app. Use the following structure in your request: organizations/org/appgroups/app_group_name/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



2269
2270
2271
2272
2273
2274
2275
2276
2277
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2269

def get_organization_appgroup_app(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp
  command.params['name'] = name unless name.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_appgroup_app_key(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey

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

Parameters:

  • name (String) —

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



2466
2467
2468
2469
2470
2471
2472
2473
2474
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2466

def get_organization_appgroup_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::GoogleCloudApigeeV1AppGroupAppKey::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey
  command.params['name'] = name unless name.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



2790
2791
2792
2793
2794
2795
2796
2797
2798
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2790

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



230
231
232
233
234
235
236
237
238
239
 
# File 'lib/google/apis/apigee_v1/service.rb', line 230

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



3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3052

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



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

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



3665
3666
3667
3668
3669
3670
3671
3672
3673
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3665

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



3851
3852
3853
3854
3855
3856
3857
3858
3859
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3851

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



4118
4119
4120
4121
4122
4123
4124
4125
4126
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4118

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



3084
3085
3086
3087
3088
3089
3090
3091
3092
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3084

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



3116
3117
3118
3119
3120
3121
3122
3123
3124
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3116

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



4361
4362
4363
4364
4365
4366
4367
4368
4369
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4361

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



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

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



4642
4643
4644
4645
4646
4647
4648
4649
4650
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4642

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



4849
4850
4851
4852
4853
4854
4855
4856
4857
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4849

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

Gets the deployed ingress configuration for an environment group.

Parameters:

  • name (String) —

    Required. Name of the deployed configuration for the environment group in the following format: 'organizations/org/envgroups/envgroup/ 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



4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4677

def get_organization_envgroup_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::GoogleCloudApigeeV1EnvironmentGroupConfig::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentGroupConfig
  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_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



4990
4991
4992
4993
4994
4995
4996
4997
4998
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4990

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

Gets the add-ons config of an environment.

Parameters:

  • name (String) —

    Required. Name of the add-ons config. Must be in the format of /organizations/ org/environments/env/addonsConfig

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5021
5022
5023
5024
5025
5026
5027
5028
5029
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5021

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



5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5679

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



5750
5751
5752
5753
5754
5755
5756
5757
5758
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5750

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



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

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



6133
6134
6135
6136
6137
6138
6139
6140
6141
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6133

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



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

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

Gets the API Security runtime configuration for an environment. This named ApiSecurityRuntimeConfig to prevent conflicts with ApiSecurityConfig from addon config.

Parameters:

  • name (String) —

    Required. Name of the environment API Security Runtime configuration resource. Use the following structure in your request: organizations/org/environments/ env/apiSecurityRuntimeConfig

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5055
5056
5057
5058
5059
5060
5061
5062
5063
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5055

def get_organization_environment_api_security_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::GoogleCloudApigeeV1ApiSecurityRuntimeConfig::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiSecurityRuntimeConfig
  command.params['name'] = name unless name.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



6394
6395
6396
6397
6398
6399
6400
6401
6402
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6394

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



5086
5087
5088
5089
5090
5091
5092
5093
5094
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5086

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



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

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

Gets a particular deployment of Api proxy or a shared flow in an environment

Parameters:

  • name (String) —

    Required. Name of the api proxy or the shared flow deployment. Use the following structure in your request: organizations/org/environments/env/ deployments/deployment``

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6538
6539
6540
6541
6542
6543
6544
6545
6546
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6538

def get_organization_environment_deployment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', 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_deployment_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 a deployment. For more information, see Manage users, roles, and permissions using the API. You must have the apigee. deployments.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



6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6584

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



6796
6797
6798
6799
6800
6801
6802
6803
6804
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6796

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



5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5164

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



6898
6899
6900
6901
6902
6903
6904
6905
6906
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6898

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



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

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



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

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 a key value map scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.

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



7315
7316
7317
7318
7319
7320
7321
7322
7323
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7315

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



7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7473

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



7558
7559
7560
7561
7562
7563
7564
7565
7566
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7558

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



7593
7594
7595
7596
7597
7598
7599
7600
7601
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7593

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



7626
7627
7628
7629
7630
7631
7632
7633
7634
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7626

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



7775
7776
7777
7778
7779
7780
7781
7782
7783
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7775

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



7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7933

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

Get a SecurityAction by name.

Parameters:

  • name (String) —

    Required. The fully qualified name of the SecurityAction to retrieve. Format: organizations/org/environments/env/securityActions/security_action

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



8195
8196
8197
8198
8199
8200
8201
8202
8203
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8195

def get_organization_environment_security_action(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityAction::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityAction
  command.params['name'] = name unless name.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_actions_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityActionsConfig

GetSecurityActionConfig returns the current SecurityActions configuration.

Parameters:

  • name (String) —

    Required. The name of the SecurityActionsConfig to retrieve. This will always be: organizations/org/environments/env/security_actions_config

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5196
5197
5198
5199
5200
5201
5202
5203
5204
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5196

def get_organization_environment_security_actions_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityActionsConfig::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityActionsConfig
  command.params['name'] = name unless name.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_incident(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityIncident

GetSecurityIncident gets the specified security incident. Returns NOT_FOUND if security incident is not present for the specified organization and environment.

Parameters:

  • name (String) —

    Required. Security incident in the following format: organizations/org/ environments/environment/securityIncidents/incident`'. Example: organizations/testOrg/environments/testEnv/securityIncidents/1234-4567-890-111

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



8313
8314
8315
8316
8317
8318
8319
8320
8321
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8313

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



8467
8468
8469
8470
8471
8472
8473
8474
8475
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8467

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



8502
8503
8504
8505
8506
8507
8508
8509
8510
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8502

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



8534
8535
8536
8537
8538
8539
8540
8541
8542
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8534

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



8770
8771
8772
8773
8774
8775
8776
8777
8778
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8770

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



8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8888

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



9004
9005
9006
9007
9008
9009
9010
9011
9012
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9004

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



5227
5228
5229
5230
5231
5232
5233
5234
5235
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5227

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



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

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



9292
9293
9294
9295
9296
9297
9298
9299
9300
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9292

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



9327
9328
9329
9330
9331
9332
9333
9334
9335
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9327

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



9358
9359
9360
9361
9362
9363
9364
9365
9366
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9358

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



9481
9482
9483
9484
9485
9486
9487
9488
9489
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9481

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



9516
9517
9518
9519
9520
9521
9522
9523
9524
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9516

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



9548
9549
9550
9551
9552
9553
9554
9555
9556
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9548

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



9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9680

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



9794
9795
9796
9797
9798
9799
9800
9801
9802
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9794

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



10004
10005
10006
10007
10008
10009
10010
10011
10012
 
# File 'lib/google/apis/apigee_v1/service.rb', line 10004

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



10108
10109
10110
10111
10112
10113
10114
10115
10116
 
# File 'lib/google/apis/apigee_v1/service.rb', line 10108

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



10244
10245
10246
10247
10248
10249
10250
10251
10252
 
# File 'lib/google/apis/apigee_v1/service.rb', line 10244

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 a key value map scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.

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



10463
10464
10465
10466
10467
10468
10469
10470
10471
 
# File 'lib/google/apis/apigee_v1/service.rb', line 10463

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



10576
10577
10578
10579
10580
10581
10582
10583
10584
 
# File 'lib/google/apis/apigee_v1/service.rb', line 10576

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



10688
10689
10690
10691
10692
10693
10694
10695
10696
10697
10698
10699
10700
10701
10702
10703
10704
10705
10706
10707
10708
10709
10710
 
# File 'lib/google/apis/apigee_v1/service.rb', line 10688

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



262
263
264
265
266
267
268
269
270
 
# File 'lib/google/apis/apigee_v1/service.rb', line 262

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



10804
10805
10806
10807
10808
10809
10810
10811
10812
 
# File 'lib/google/apis/apigee_v1/service.rb', line 10804

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



293
294
295
296
297
298
299
300
301
 
# File 'lib/google/apis/apigee_v1/service.rb', line 293

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



11009
11010
11011
11012
11013
11014
11015
11016
11017
 
# File 'lib/google/apis/apigee_v1/service.rb', line 11009

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

GetSecuritySettings gets the security settings for API Security.

Parameters:

  • name (String) —

    Required. The name of the SecuritySettings to retrieve. This will always be: ' organizations/org/securitySettings'.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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



11335
11336
11337
11338
11339
11340
11341
11342
11343
 
# File 'lib/google/apis/apigee_v1/service.rb', line 11335

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



11477
11478
11479
11480
11481
11482
11483
11484
11485
11486
 
# File 'lib/google/apis/apigee_v1/service.rb', line 11477

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

Gets an API category.

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



11649
11650
11651
11652
11653
11654
11655
11656
11657
 
# File 'lib/google/apis/apigee_v1/service.rb', line 11649

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::GoogleCloudApigeeV1ApiCategoryResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategoryResponse
  command.params['name'] = name unless name.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_apidoc(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocResponse

Gets a catalog item.

Parameters:

  • name (String) —

    Required. Name of the catalog item. Use the following structure in your request: organizations/org/sites/site/apidocs/apidoc``

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



11810
11811
11812
11813
11814
11815
11816
11817
11818
 
# File 'lib/google/apis/apigee_v1/service.rb', line 11810

def get_organization_site_apidoc(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocResponse
  command.params['name'] = name unless name.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_apidoc_documentation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocDocumentationResponse

Gets the documentation for the specified catalog item.

Parameters:

  • name (String) —

    Required. Resource name of the catalog item documentation. Use the following structure in your request: organizations/org/sites/site/apidocs/apidoc/ 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



11842
11843
11844
11845
11846
11847
11848
11849
11850
 
# File 'lib/google/apis/apigee_v1/service.rb', line 11842

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



364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/google/apis/apigee_v1/service.rb', line 364

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



79
80
81
82
83
84
85
86
87
 
# File 'lib/google/apis/apigee_v1/service.rb', line 79

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



677
678
679
680
681
682
683
684
685
686
 
# File 'lib/google/apis/apigee_v1/service.rb', line 677

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



1566
1567
1568
1569
1570
1571
1572
1573
1574
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1566

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. Note: Supported for Apigee hybrid 1.8.x and higher.

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



1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1788

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



1976
1977
1978
1979
1980
1981
1982
1983
1984
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1976

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



1102
1103
1104
1105
1106
1107
1108
1109
1110
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1102

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



1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1298

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



963
964
965
966
967
968
969
970
971
972
973
974
975
976
 
# File 'lib/google/apis/apigee_v1/service.rb', line 963

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



1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1496

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

Lists all apps created by an AppGroup in an Apigee organization. Optionally, you can request an expanded view of the AppGroup apps. Lists all AppGroupApps in an AppGroup. A maximum of 1000 AppGroup apps are returned in the response if PageSize is not specified, or if the PageSize is greater than 1000.

Parameters:

  • parent (String) —

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

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

    Optional. Maximum number entries to return. If unspecified, at most 1000 entries will be returned.

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

    Optional. Page token. If provides, must be a valid AppGroup app 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



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

def list_organization_appgroup_apps(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/apps', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAppGroupAppsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAppGroupAppsResponse
  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_appgroups(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAppGroupsResponse

Lists all AppGroups in an organization. A maximum of 1000 AppGroups are returned in the response if PageSize is not specified, or if the PageSize is greater than 1000.

Parameters:

  • parent (String) —

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

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

    The filter expression to be used to get the list of AppGroups, where filtering can be done on status, channelId or channelUri of the app group. Examples: filter=status=active", filter=channelId=, filter=channelUri=

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

    Count of AppGroups a single page can have in the response. If unspecified, at most 1000 AppGroups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

    The starting index record for listing the AppGroups.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the 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 list_organization_appgroups(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/appgroups', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAppGroupsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAppGroupsResponse
  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_apps(parent, api_product: nil, apptype: nil, expand: nil, filter: nil, ids: nil, include_cred: nil, key_status: nil, page_size: nil, page_token: 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. 'apptype' is no longer available. Use a 'filter' instead.

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

    Optional. Flag that specifies whether to return an expanded list of apps for the organization. Defaults to false.

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

    Optional. The filter expression to be used to get the list of apps, where filtering can be done on developerEmail, apiProduct, consumerKey, status, appId, appName, appType and appGroup. Examples: "developerEmail=foo@bar.com", " appType=AppGroup", or "appType=Developer" "filter" is supported from ver 1.10. 0 and above.

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

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

    Optional. Count of apps a single page can have in the response. If unspecified, at most 100 apps will be returned. The maximum value is 100; values above 100 will be coerced to 100. "page_size" is supported from ver 1.10.0 and above.

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

    Optional. The starting index record for listing the developers. "page_token" is supported from ver 1.10.0 and above.

  • 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



2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2677

def list_organization_apps(parent, api_product: nil, apptype: nil, expand: nil, filter: nil, ids: nil, include_cred: nil, key_status: nil, page_size: nil, page_token: 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['filter'] = filter unless filter.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['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.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



2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2826

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



2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2900

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



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

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



3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3554

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



4150
4151
4152
4153
4154
4155
4156
4157
4158
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4150

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



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

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



3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3172

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



4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4540

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



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

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



4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4714

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



5782
5783
5784
5785
5786
5787
5788
5789
5790
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5782

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



5813
5814
5815
5816
5817
5818
5819
5820
5821
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5813

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



6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6099

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



6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6434

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



6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6620

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. Note: Supported for Apigee hybrid 1.8.x and higher.

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



7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7357

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



7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7672

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



8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8006

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



7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7970

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

Returns a list of SecurityActions. This returns both enabled and disabled actions.

Parameters:

  • parent (String) —

    Required. The parent, which owns this collection of SecurityActions. Format: organizations/org/environments/env

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

    The filter expression to filter List results. https://google.aip.dev/160. Allows for filtering over: state and api_proxies. E.g.: state = ACTIVE AND apiProxies:foo. Filtering by action is not supported https://github.com/aip- dev/google.aip.dev/issues/624

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

    The maximum number of SecurityActions to return. If unspecified, at most 50 SecurityActions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

    A page token, received from a previous ListSecurityActions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSecurityActions must match the call that provided 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



8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8241

def list_organization_environment_security_actions(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/securityActions', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListSecurityActionsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListSecurityActionsResponse
  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_security_incidents(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListSecurityIncidentsResponse

ListSecurityIncidents lists all the security incident associated with the environment.

Parameters:

  • parent (String) —

    Required. For a specific organization, list of all the security incidents. Format: organizations/org/environments/environment``

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

    The filter expression to be used to get the list of security incidents, where filtering can be done on API Proxies. Example: filter = "api_proxy = /", " first_detected_time >", "last_detected_time <"

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

    Optional. The maximum number of incidents to return. The service may return fewer than this value. If unspecified, at most 50 incidents will be returned.

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

    Optional. A page token, received from a previous ListSecurityIncident 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



8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8355

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



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

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



8685
8686
8687
8688
8689
8690
8691
8692
8693
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8685

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



9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9181

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



9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9405

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



9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9596

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



10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
 
# File 'lib/google/apis/apigee_v1/service.rb', line 10041

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



10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
 
# File 'lib/google/apis/apigee_v1/service.rb', line 10281

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



9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9831

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. Note: Supported for Apigee hybrid 1.8.x and higher.

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



10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
 
# File 'lib/google/apis/apigee_v1/service.rb', line 10505

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.

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



10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624
 
# File 'lib/google/apis/apigee_v1/service.rb', line 10613

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



10837
10838
10839
10840
10841
10842
10843
10844
10845
10846
 
# File 'lib/google/apis/apigee_v1/service.rb', line 10837

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



11086
11087
11088
11089
11090
11091
11092
11093
11094
11095
11096
 
# File 'lib/google/apis/apigee_v1/service.rb', line 11086

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



11047
11048
11049
11050
11051
11052
11053
11054
11055
11056
11057
 
# File 'lib/google/apis/apigee_v1/service.rb', line 11047

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



11403
11404
11405
11406
11407
11408
11409
11410
11411
 
# File 'lib/google/apis/apigee_v1/service.rb', line 11403

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



11553
11554
11555
11556
11557
11558
11559
11560
11561
 
# File 'lib/google/apis/apigee_v1/service.rb', line 11553

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



11370
11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
 
# File 'lib/google/apis/apigee_v1/service.rb', line 11370

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

Returns the API categories associated with a 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



11680
11681
11682
11683
11684
11685
11686
11687
11688
 
# File 'lib/google/apis/apigee_v1/service.rb', line 11680

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

Returns the catalog items associated with a portal.

Parameters:

  • parent (String) —

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

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

    Optional. The maximum number of items to return. The service may return fewer than this value. If unspecified, at most 25 books will be returned. The maximum value is 100; values above 100 will be coerced to 100.

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

    Optional. A page token, received from a previous ListApiDocs 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



11880
11881
11882
11883
11884
11885
11886
11887
11888
11889
11890
 
# File 'lib/google/apis/apigee_v1/service.rb', line 11880

def list_organization_site_apidocs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/apidocs', options)
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiDocsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiDocsResponse
  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_organizations(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListOrganizationsResponse

Lists the Apigee organizations and associated Google Cloud 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



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

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

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

Updates properties for an Apigee environment with patch semantics using a field mask. Note: Not supported for Apigee hybrid.

Parameters:

  • name (String) —

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

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

    List of fields to be updated. Fields that can be updated: node_config.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

def modify_organization_environment_environment(name, google_cloud_apigee_v1_environment_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::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['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_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



1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1532

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



2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2862

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

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



4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4750

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



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

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_security_incident(name, google_cloud_apigee_v1_security_incident_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityIncident

UpdateSecurityIncidents updates an existing security incident.

Parameters:

  • name (String) —

    Immutable. Name of the security incident resource. Format: organizations/org/ environments/environment/securityIncidents/incident Example: organizations/ apigee-org/environments/dev/securityIncidents/1234-5678-9101-1111

  • google_cloud_apigee_v1_security_incident_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityIncident) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The list of fields to update. Allowed fields are: LINT.IfChange( allowed_update_fields_comment) - observability LINT.ThenChange()

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8394

def patch_organization_environment_security_incident(name, google_cloud_apigee_v1_security_incident_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::GoogleCloudApigeeV1SecurityIncident::Representation
  command.request_object = google_cloud_apigee_v1_security_incident_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityIncident::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityIncident
  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



9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9220

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



9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9869

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_security_profile(name, google_cloud_apigee_v1_security_profile_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityProfile

UpdateSecurityProfile update the metadata of security profile.

Parameters:

  • name (String) —

    Immutable. Name of the security profile resource. Format: organizations/org/ securityProfiles/profile

  • google_cloud_apigee_v1_security_profile_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityProfile) (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



11122
11123
11124
11125
11126
11127
11128
11129
11130
11131
11132
11133
 
# File 'lib/google/apis/apigee_v1/service.rb', line 11122

def patch_organization_security_profile(name, google_cloud_apigee_v1_security_profile_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::GoogleCloudApigeeV1SecurityProfile::Representation
  command.request_object = google_cloud_apigee_v1_security_profile_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityProfile::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityProfile
  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_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategoryResponse

Updates an API category.

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_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategory) (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



11712
11713
11714
11715
11716
11717
11718
11719
11720
11721
11722
 
# File 'lib/google/apis/apigee_v1/service.rb', line 11712

def patch_organization_site_apicategory(name, google_cloud_apigee_v1_api_category_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategory::Representation
  command.request_object = google_cloud_apigee_v1_api_category_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategoryResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategoryResponse
  command.params['name'] = name unless name.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



11985
11986
11987
11988
11989
11990
11991
11992
11993
11994
11995
 
# File 'lib/google/apis/apigee_v1/service.rb', line 11985

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

#query_organization_environment_security_stat_tabular_stats(orgenv, google_cloud_apigee_v1_query_tabular_stats_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1QueryTabularStatsResponse

Retrieve security statistics as tabular rows.

Parameters:

  • orgenv (String) —

    Required. Should be of the form organizations//environments/.

  • google_cloud_apigee_v1_query_tabular_stats_request_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1QueryTabularStatsRequest) (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



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

def query_organization_environment_security_stat_tabular_stats(orgenv, google_cloud_apigee_v1_query_tabular_stats_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+orgenv}/securityStats:queryTabularStats', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1QueryTabularStatsRequest::Representation
  command.request_object = google_cloud_apigee_v1_query_tabular_stats_request_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1QueryTabularStatsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1QueryTabularStatsResponse
  command.params['orgenv'] = orgenv unless orgenv.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#query_organization_environment_security_stat_time_series_stats(orgenv, google_cloud_apigee_v1_query_time_series_stats_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1QueryTimeSeriesStatsResponse

Retrieve security statistics as a collection of time series.

Parameters:

  • orgenv (String) —

    Required. Should be of the form organizations//environments/.

  • google_cloud_apigee_v1_query_time_series_stats_request_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1QueryTimeSeriesStatsRequest) (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



8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8652

def query_organization_environment_security_stat_time_series_stats(orgenv, google_cloud_apigee_v1_query_time_series_stats_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+orgenv}/securityStats:queryTimeSeriesStats', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1QueryTimeSeriesStatsRequest::Representation
  command.request_object = google_cloud_apigee_v1_query_time_series_stats_request_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1QueryTimeSeriesStatsResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1QueryTimeSeriesStatsResponse
  command.params['orgenv'] = orgenv unless orgenv.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



3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3887

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



9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9905

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



431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/google/apis/apigee_v1/service.rb', line 431

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



3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3219

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

Updates an add-on enablement status of an environment.

Parameters:

  • name (String) —

    Required. Name of the add-ons config. Must be in the format of /organizations/ org/environments/env/addonsConfig

  • google_cloud_apigee_v1_set_addon_enablement_request_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1SetAddonEnablementRequest) (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



5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5637

def set_organization_environment_addons_config_addon_enablement(name, google_cloud_apigee_v1_set_addon_enablement_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:setAddonEnablement', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SetAddonEnablementRequest::Representation
  command.request_object = google_cloud_apigee_v1_set_addon_enablement_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

#set_organization_environment_deployment_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 a deployment, 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.deployments. 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



6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6658

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



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

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



473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/google/apis/apigee_v1/service.rb', line 473

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



5337
5338
5339
5340
5341
5342
5343
5344
5345
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5337

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



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

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_deployment_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 a deployment, and returns a subset of permissions that the user has on the deployment. If the deployment 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



6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
 
# File 'lib/google/apis/apigee_v1/service.rb', line 6695

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

#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



5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5372

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



5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5956

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



8807
8808
8809
8810
8811
8812
8813
8814
8815
 
# File 'lib/google/apis/apigee_v1/service.rb', line 8807

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



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

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



508
509
510
511
512
513
514
515
516
517
518
 
# File 'lib/google/apis/apigee_v1/service.rb', line 508

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



746
747
748
749
750
751
752
753
754
755
756
 
# File 'lib/google/apis/apigee_v1/service.rb', line 746

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

Update key value entry scoped to an organization, environment, or API proxy for an existing key.

Parameters:

  • name (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



1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1826

def update_organization_api_keyvaluemap_entry(name, google_cloud_apigee_v1_key_value_entry_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', 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['name'] = name unless name.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



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

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



1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1005

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



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

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



1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
 
# File 'lib/google/apis/apigee_v1/service.rb', line 1335

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_appgroup(name, google_cloud_apigee_v1_app_group_object = nil, action: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup

Updates an AppGroup. This API replaces the existing AppGroup details with those specified in the request. Include or exclude any existing details that you want to retain or delete, respectively. Note that the state of the AppGroup should be updated using action, and not via AppGroup.

Parameters:

  • name (String) —

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

  • google_cloud_apigee_v1_app_group_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup) (defaults to: nil)
  • action (String) (defaults to: nil) —

    Activate or de-activate the AppGroup by setting the action as active or inactive. The Content-Type header must be set to application/octet-stream, with empty body.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2164

def update_organization_appgroup(name, google_cloud_apigee_v1_app_group_object = nil, action: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup::Representation
  command.request_object = google_cloud_apigee_v1_app_group_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup
  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_appgroup_app(name, google_cloud_apigee_v1_app_group_app_object = nil, action: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp

Updates the details for an AppGroup app. In addition, you can add an API product to an AppGroup 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 UpdateAppGroupAppKey API. Using this API, you cannot update the app name, as it is the primary key used to identify the app and cannot be changed. 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 AppGroup app. Use the following structure in your request: organizations/org/appgroups/app_group_name/apps/app``

  • google_cloud_apigee_v1_app_group_app_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp) (defaults to: nil)
  • action (String) (defaults to: nil) —

    Approve or revoke the consumer key by setting this value to approve or revoke. The Content-Type header must be set to application/octet-stream, with empty body.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2355

def update_organization_appgroup_app(name, google_cloud_apigee_v1_app_group_app_object = nil, action: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp::Representation
  command.request_object = google_cloud_apigee_v1_app_group_app_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp
  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_appgroup_app_key_apiproduct_app_group_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) —

    Required. Name of the API product in the developer app key in the following format: organizations/org/appgroups/app_group_name/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. The Content-Type header, if set, must be set to application/octet-stream, with empty body.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2580

def update_organization_appgroup_app_key_apiproduct_app_group_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_appgroup_app_key_app_group_app_key(name, google_cloud_apigee_v1_update_app_group_app_key_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey

Adds an API product to an AppGroupAppKey, enabling the app that holds the key to access the API resources bundled in the API product. In addition, you can add attributes to the AppGroupAppKey. 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) —

    Required. Name of the AppGroup app key. Use the following structure in your request: organizations/org/appgroups/app_group_name/apps/app/keys/key``

  • google_cloud_apigee_v1_update_app_group_app_key_request_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest) (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



2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
 
# File 'lib/google/apis/apigee_v1/service.rb', line 2503

def update_organization_appgroup_app_key_app_group_app_key(name, google_cloud_apigee_v1_update_app_group_app_key_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest::Representation
  command.request_object = google_cloud_apigee_v1_update_app_group_app_key_request_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey
  command.params['name'] = name unless name.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



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

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



3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3599

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



3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
 
# File 'lib/google/apis/apigee_v1/service.rb', line 3734

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



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

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



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

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



4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
 
# File 'lib/google/apis/apigee_v1/service.rb', line 4188

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



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

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



5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5445

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



5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5484

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



5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5525

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



7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7130

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

Update key value entry scoped to an organization, environment, or API proxy for an existing key.

Parameters:

  • name (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



7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7395

def update_organization_environment_keyvaluemap_entry(name, google_cloud_apigee_v1_key_value_entry_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', 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['name'] = name unless name.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



7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
 
# File 'lib/google/apis/apigee_v1/service.rb', line 7809

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



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

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_security_actions_config(name, google_cloud_apigee_v1_security_actions_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityActionsConfig

UpdateSecurityActionConfig updates the current SecurityActions configuration. This method is used to enable/disable the feature at the environment level.

Parameters:

  • name (String) —

    This is a singleton resource, the name will always be set by SecurityActions and any user input will be ignored. The name is always: organizations/org/ environments/env/security_actions_config

  • google_cloud_apigee_v1_security_actions_config_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityActionsConfig) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    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



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

def update_organization_environment_security_actions_config(name, google_cloud_apigee_v1_security_actions_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::GoogleCloudApigeeV1SecurityActionsConfig::Representation
  command.request_object = google_cloud_apigee_v1_security_actions_config_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityActionsConfig::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityActionsConfig
  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_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



9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
 
# File 'lib/google/apis/apigee_v1/service.rb', line 9038

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



5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
 
# File 'lib/google/apis/apigee_v1/service.rb', line 5602

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

Update key value entry scoped to an organization, environment, or API proxy for an existing key.

Parameters:

  • name (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



10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
 
# File 'lib/google/apis/apigee_v1/service.rb', line 10543

def update_organization_keyvaluemap_entry(name, google_cloud_apigee_v1_key_value_entry_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', 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['name'] = name unless name.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



10870
10871
10872
10873
10874
10875
10876
10877
10878
10879
10880
 
# File 'lib/google/apis/apigee_v1/service.rb', line 10870

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_security_settings(name, google_cloud_apigee_v1_security_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecuritySettings

UpdateSecuritySettings updates the current security settings for API Security.

Parameters:

  • name (String) —

    Identifier. Full resource name is always organizations/org/securitySettings .

  • google_cloud_apigee_v1_security_settings_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecuritySettings) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Optional. The list of fields to update. Allowed fields are: - ml_retraining_feedback_enabled

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



545
546
547
548
549
550
551
552
553
554
555
556
 
# File 'lib/google/apis/apigee_v1/service.rb', line 545

def update_organization_security_settings(name, google_cloud_apigee_v1_security_settings_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::GoogleCloudApigeeV1SecuritySettings::Representation
  command.request_object = google_cloud_apigee_v1_security_settings_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecuritySettings::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecuritySettings
  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_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



11518
11519
11520
11521
11522
11523
11524
11525
11526
11527
11528
11529
 
# File 'lib/google/apis/apigee_v1/service.rb', line 11518

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

#update_organization_site_apidoc(name, google_cloud_apigee_v1_api_doc_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocResponse

Updates a catalog item.

Parameters:

  • name (String) —

    Required. Name of the catalog item. Use the following structure in your request: organizations/org/sites/site/apidocs/apidoc``

  • google_cloud_apigee_v1_api_doc_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDoc) (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



11914
11915
11916
11917
11918
11919
11920
11921
11922
11923
11924
 
# File 'lib/google/apis/apigee_v1/service.rb', line 11914

def update_organization_site_apidoc(name, google_cloud_apigee_v1_api_doc_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDoc::Representation
  command.request_object = google_cloud_apigee_v1_api_doc_object
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocResponse::Representation
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocResponse
  command.params['name'] = name unless name.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_site_apidoc_documentation(name, google_cloud_apigee_v1_api_doc_documentation_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocDocumentationResponse

Updates the documentation for the specified catalog item. Note that the documentation file contents will not be populated in the return message.

Parameters:

  • name (String) —

    Required. Resource name of the catalog item documentation. Use the following structure in your request: organizations/org/sites/site/apidocs/apidoc/ documentation

  • google_cloud_apigee_v1_api_doc_documentation_object (Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocDocumentation) (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



11950
11951
11952
11953
11954
11955
11956
11957
11958
11959
11960
 
# File 'lib/google/apis/apigee_v1/service.rb', line 11950

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