For information on using the APIs described # in this section, see # Get started using the APIs.
Note: This product is
# available as a free trial for a time period of 60 days.
#
# @example
# require 'google/apis/apigee_v1'
#
# Apigee = Google::Apis::ApigeeV1 # Alias the module
# service = Apigee::ApigeeService.new
#
# @see https://cloud.google.com/apigee-api-management/
class ApigeeService < Google::Apis::Core::BaseService
# @return [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.
attr_accessor :key
# @return [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.
attr_accessor :quota_user
def initialize
super('https://apigee.googleapis.com/', '')
@batch_path = 'batch'
end
# 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.
# @param [String] name
# Required. Must be of the form `hybrid/issuers`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListHybridIssuersResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListHybridIssuersResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Creates an Apigee organization. See
# [Create an
# organization](https://docs.apigee.com/hybrid/latest/precog-provision).
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization] google_cloud_apigee_v1_organization_object
# @param [String] parent
# Required. Name of the GCP project in which to associate the Apigee
# organization.
# Pass the information as a query parameter using the following structure
# in your request:
# `projects/organizations/organization_ID/apiproducts/
# api_product_name
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] google_cloud_apigee_v1_attributes_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
#
# For more information, see ``what_api_product``
# @param [String] parent
# Required. The parent organization name under which the API product will
# be created. Must be in the following form:
# organizations/organization_ID
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct] google_cloud_apigee_v1_api_product_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [String] name
# Required. API product name in the following form:
# organizations/organization_ID/apiproducts/
# api_product_name
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [String] name
# **Required.** API product name in the following form:
# organizations/organization_ID/apiproducts/
# api_product_name
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Lists all API product names for an organization.
# Filter the list by passing an `attributename` and `attibutevalue`.
# The limit on the number of API products returned by the API is 1000. You
# can paginate the list of API products returned using the `startKey` and
# `count` query parameters.
# @param [String] parent
# **Required.** The parent organization name in the following form:
# organizations/organization_ID
# @param [String] attributename
# The name of the attribute to search.
# @param [String] attributevalue
# The value of the attribute.
# @param [Fixnum] count
# Enter the number of API products you want returned in the API call. The
# limit is 1000.
# @param [Boolean] expand
# Set to `true` to get expanded details about each API.
# @param [String] start_key
# 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.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiProductsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiProductsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [String] name
# **Required.** API product name in the following form:
# organizations/organization_ID/apiproducts/
# api_product_name
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct] google_cloud_apigee_v1_api_product_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Deletes an API product attribute.
# @param [String] name
# **Required.** API product name in the following form:
# organizations/organization_ID/apiproducts/
# api_product_name/attributes/attribute_name
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Returns the value of an API product attribute.
# @param [String] name
# **Required.** API product name in the following form:
# organizations/organization_ID/apiproducts/
# api_product_name/attributes/attribute_name
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Returns a list of all API product attributes.
# @param [String] parent
# Required. The parent organization name. Must be in the following form:
# organizations/organization_ID/apiproducts/
# api_product_name
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Updates the value of an API product attribute. Limitations are:
# 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.
# @param [String] name
# **Required.** API product name in the following form:
# organizations/organization_ID/apiproducts/
# api_product_name
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] google_cloud_apigee_v1_attribute_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [String] parent
# Required. Name of the organization in the following format:
# `organizations/`org``
# @param [Google::Apis::ApigeeV1::GoogleApiHttpBody] google_api_http_body_object
# @param [String] action
# 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.
# @param [String] name
# Name of the API proxy. Restrict the characters used to: A-Za-z0-9._-
# @param [Boolean] validate
# Ignored. All uploads are validated regardless of the value of this
# field. Maintained for compatibility with Apigee Edge API.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Deletes an API proxy and all associated endpoints, policies, resources, and
# revisions. The API proxy must be undeployed before you can delete it.
# @param [String] name
# Required. Name of the API proxy in the following format:
# `organizations/`org`/apis/`api``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Gets an API proxy including a list of existing revisions.
# @param [String] name
# Required. Name of the API proxy in the following format:
# `organizations/`org`/apis/`api``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [String] parent
# Required. Name of the organization in the following format:
# `organizations/`org``
# @param [Boolean] include_meta_data
# Flag that specifies whether to include API proxy metadata in the response.
# @param [Boolean] include_revisions
# Flag that specifies whether to include a list of revisions in the response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiProxiesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiProxiesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Lists all deployments of an API proxy.
# @param [String] parent
# Required. Name of the API proxy for which to return deployment information in
# the
# following format:
# `organizations/`org`/apis/`api``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Creates a key value map in an api proxy.
# @param [String] parent
# Required. The name of the environment in which to create the key value map.
# Must be of the form
# `organizations/`organization`/apis/`api``.
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] google_cloud_apigee_v1_key_value_map_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Delete a key value map in an api proxy.
# @param [String] name
# Required. The name of the key value map.
# Must be of the form
# `organizations/`organization`/apis/`api`/keyvaluemaps/`keyvaluemap``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [String] name
# Required. API proxy revision in the following format:
# `organizations/`org`/apis/`api`/revisions/`rev``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Gets an API proxy revision.
# To download the API proxy configuration bundle for the specified revision
# as a zip file, do the following:
# * Set the `format` query parameter to `bundle`.
# * Set the `Accept` header to `application/zip`.
# If you are using curl, specify `-o filename.zip` to save the output to a
# file; otherwise, it displays to `stdout`. Then, develop the API proxy
# configuration locally and upload the updated API proxy configuration
# revision, as described in
# [updateApiProxyRevision](updateApiProxyRevision).
# @param [String] name
# Required. API proxy revision in the following format:
# `organizations/`org`/apis/`api`/revisions/`rev``
# @param [String] format
# Format used when downloading the API proxy configuration revision.
# Set to `bundle` to download the API proxy configuration revision as a zip
# file.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleApiHttpBody] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleApiHttpBody]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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`.
# @param [String] name
# Required. API proxy revision to update in the following format:
# `organizations/`org`/apis/`api`/revisions/`rev``
# @param [Google::Apis::ApigeeV1::GoogleApiHttpBody] google_api_http_body_object
# @param [Boolean] validate
# Ignored. All uploads are validated regardless of the value of this field.
# Maintained for compatibility with Apigee Edge API.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Lists all deployments of an API proxy revision.
# @param [String] parent
# Required. Name of the API proxy revision for which to return deployment
# information
# in the following format:
# `organizations/`org`/apis/`api`/revisions/`rev``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Gets the app profile for the specified app ID.
# @param [String] name
# Required. App ID in the following format:
# `organizations/`org`/apps/`app``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1App] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1App]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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).
# @param [String] parent
# Required. Resource path of the parent in the following format:
# `organizations/`org``
# @param [String] api_product
# API product.
# @param [String] apptype
# Optional. Filter by the type of the app. Valid values are `company` or
# `developer`. Defaults to `developer`.
# @param [Boolean] expand
# Optional. Flag that specifies whether to return an expanded list of
# apps for the organization. Defaults to `false`.
# @param [String] ids
# Optional. Comma-separated list of app IDs on which to filter.
# @param [Boolean] include_cred
# Optional. Flag that specifies whether to include credentials in the
# response.
# @param [String] key_status
# Optional. Key status of the app. Valid values include `approved` or
# `revoked`. Defaults to `approved`.
# @param [Fixnum] rows
# Optional. Maximum number of app IDs to return. Defaults to 10000.
# @param [String] start_key
# Returns the list of apps starting from the specified app ID.
# @param [String] status
# Optional. Filter by the status of the app. Valid values are `approved`
# or `revoked`. Defaults to `approved`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAppsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAppsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_apps(parent, api_product: nil, apptype: nil, expand: nil, ids: nil, include_cred: nil, key_status: nil, rows: nil, start_key: nil, status: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/apps', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAppsResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAppsResponse
command.params['parent'] = parent unless parent.nil?
command.query['apiProduct'] = api_product unless api_product.nil?
command.query['apptype'] = apptype unless apptype.nil?
command.query['expand'] = expand unless expand.nil?
command.query['ids'] = ids unless ids.nil?
command.query['includeCred'] = include_cred unless include_cred.nil?
command.query['keyStatus'] = key_status unless key_status.nil?
command.query['rows'] = rows unless rows.nil?
command.query['startKey'] = start_key unless start_key.nil?
command.query['status'] = status unless status.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists all deployments of API proxies or shared flows.
# @param [String] parent
# Required. Name of the organization for which to return deployment information
# in the
# following format:
# `organizations/`org``
# @param [Boolean] shared_flows
# 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`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [String] parent
# Required. Email address of the developer for which attributes are being
# updated in
# the following format:
# `organizations/`org`/developers/`developer_email``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] google_cloud_apigee_v1_attributes_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [String] parent
# Required. Name of the Apigee organization in which the developer is created.
# Use the following structure in your request:
# `organizations/`org``.
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer] google_cloud_apigee_v1_developer_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [String] name
# Required. Email address of the developer. Use the following structure in your
# request:
# `organizations/`org`/developers/`developer_email``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [String] name
# Required. Email address of the developer. Use the following structure in your
# request:
# `organizations/`org`/developers/`developer_email``
# @param [String] action
# Status of the developer. Valid values are `active` or `inactive`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [String] parent
# Required. Name of the Apigee organization. Use the following structure in your
# request:
# `organizations/`org``.
# @param [Fixnum] count
# Optional. Number of developers to return in the API call. Use with the `
# startKey`
# parameter to provide more targeted filtering.
# The limit is 1000.
# @param [Boolean] expand
# 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.
# @param [String] ids
# Optional. List of IDs to include, separated by commas.
# @param [Boolean] include_company
# Flag that specifies whether to include company details in the response.
# @param [String] start_key
# **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
# ```
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListOfDevelopersResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListOfDevelopersResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_developers(parent, 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['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
# Sets the status of a developer. Valid values are `active` or `inactive`.
# A developer is `active` by default. If you set a developer's status to
# `inactive`, the API keys assigned to the developer apps are no longer valid
# even though the API keys are set to `approved`. Inactive developers
# can still sign in to the developer portal and create apps; however, any
# new API keys generated during app creation won't work.
# If successful, the API call returns the
# following HTTP status code: `204 No Content`
# @param [String] name
# Required. Email address of the developer. Use the following structure in your
# request:
# `organizations/`org`/developers/`developer_email``
# @param [String] action
# Status of the developer. Valid values are `active` and `inactive`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleProtobufEmpty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleProtobufEmpty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [String] name
# Required. Email address of the developer. Use the following structure in your
# request:
# `organizations/`org`/developers/`developer_email``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer] google_cloud_apigee_v1_developer_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Updates attributes for a developer app. This API replaces the
# current attributes with those specified in the request.
# @param [String] name
# Required. Name of the developer app. Use the following structure in your
# request:
# `organizations/`org`/developers/`developer_email`/apps/`app``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] google_cloud_apigee_v1_attributes_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [String] parent
# Required. Name of the developer. Use the following structure in your request:
# `organizations/`org`/developers/`developer_email``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] google_cloud_apigee_v1_developer_app_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [String] name
# Required. Name of the developer app. Use the following structure in your
# request:
# `organizations/`org`/developers/`developer_email`/apps/`app``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Manages access to a developer app by enabling you to:
# * Approve or revoke a developer app
# * Generate a new consumer key and secret for a developer app
# To approve or revoke a developer app, set the `action` query parameter to
# `approved` or `revoked`, respectively, and the
# `Content-Type` header to `application/octet-stream`. If a developer app is
# revoked, none of its API keys are valid for API calls even though
# the keys are still `approved`. If successful, the API call returns the
# following HTTP status code: `204 No Content`
# To generate a new consumer key and secret for a developer
# app, pass the new key/secret details. Rather than
# replace an existing key, this API generates a new
# key. In this case, multiple key
# pairs may be associated with a single developer app. Each key pair has an
# independent status (`approved` or `revoked`) and expiration time.
# Any approved, non-expired key can be used in an API call.
# For example, if you're using API key rotation, you can generate new
# keys with expiration times that overlap keys that are going to expire.
# You might also generate a new consumer key/secret if the security of the
# original key/secret is compromised.
# The `keyExpiresIn` property defines the
# expiration time for the API key in milliseconds. If you don't set
# this property or set it to `-1`, the API key never expires.
# **Notes**:
# * When generating a new key/secret, this API replaces the
# existing attributes, notes, and callback URLs with those specified in the
# request. Include or exclude any existing information that you want to
# retain or delete, respectively.
# * To migrate existing consumer keys and secrets to hybrid from another
# system, see the
# CreateDeveloperAppKey API.
# @param [String] name
# Required. Name of the developer app. Use the following structure in your
# request:
# `organizations/`org`/developers/`developer_email`/apps/`app``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] google_cloud_apigee_v1_developer_app_object
# @param [String] action
# Action. Valid values are `approve` or `revoke`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Returns the details for a developer app.
# @param [String] name
# Required. Name of the developer app. Use the following structure in your
# request:
# `organizations/`org`/developers/`developer_email`/apps/`app``
# @param [String] entity
# **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.
# @param [String] query
# **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.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [String] parent
# Required. Name of the developer. Use the following structure in your request:
# `organizations/`org`/developers/`developer_email``
# @param [Fixnum] count
# Number of developer apps to return in the API call. Use with the `startKey`
# parameter to provide more targeted filtering.
# The limit is 1000.
# @param [Boolean] expand
# 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.
# @param [Boolean] shallow_expand
# Optional. Specifies whether to expand the results in shallow mode.
# Set to `true` to expand the results in shallow mode.
# @param [String] start_key
# **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.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeveloperAppsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeveloperAppsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [String] name
# Required. Name of the developer app. Use the following structure in your
# request:
# `organizations/`org`/developers/`developer_email`/apps/`app``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] google_cloud_apigee_v1_developer_app_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Deletes a developer app attribute.
# @param [String] name
# Required. Name of the developer app attribute. Use the following structure in
# your
# request:
# `organizations/`org`/developers/`developer_email`/apps/`app`/attributes/`
# attribute``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Returns a developer app attribute.
# @param [String] name
# Required. Name of the developer app attribute. Use the following structure in
# your
# request:
# `organizations/`org`/developers/`developer_email`/apps/`app`/attributes/`
# attribute``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Returns a list of all developer app attributes.
# @param [String] parent
# Required. Name of the developer app. Use the following structure in your
# request:
# `organizations/`org`/developers/`developer_email`/apps/`app``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [String] name
# Required. Name of the developer app attribute. Use the following structure in
# your
# request:
# `organizations/`org`/developers/`developer_email`/apps/`app`/attributes/`
# attribute``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] google_cloud_apigee_v1_attribute_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Creates a custom consumer key and secret for a developer app. This is
# particularly useful if you want to migrate existing consumer keys and
# secrets to Apigee hybrid from another system.
# Consumer keys and secrets can contain letters, numbers, underscores, and
# hyphens. No other special characters are allowed.
# **Note**: To avoid service disruptions, a consumer key and secret
# should not exceed 2 KBs each.
# After creating the consumer key and secret, associate the key with
# an API product using the
# UpdateDeveloperAppKey API.
# If a consumer key and secret already exist, you can keep them or
# delete them using the
# DeleteDeveloperAppKey API.
# @param [String] parent
# Parent of the developer app key. Use the following structure in your
# request:
# `organizations/`org`/developers/`developer_email`/apps`
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] google_cloud_apigee_v1_developer_app_key_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [String] name
# Name of the developer app key. Use the following structure in your request:
# `organizations/`org`/developers/`developer_email`/apps/`app`/keys/`key``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Returns details for a consumer key for a developer app, including the key
# and secret value, associated API products, and other information.
# @param [String] name
# Name of the developer app key. Use the following structure in your request:
# `organizations/`org`/developers/`developer_email`/apps/`app`/keys/`key``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [String] name
# Name of the developer app key. Use the following structure in your request:
# `organizations/`org`/developers/`developer_email`/apps/`app`/keys/`key``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] google_cloud_apigee_v1_developer_app_key_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [String] name
# Name of the developer app key. Use the following structure in your request:
# `organizations/`org`/developers/`developer_email`/apps/`app`/keys/`key``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] google_cloud_apigee_v1_developer_app_key_object
# @param [String] action
# Approve or revoke the consumer key by setting this value to
# `approve` or `revoke`, respectively.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [String] name
# 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``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Approve or revoke an app's consumer key. After a consumer key is approved,
# the app can use it to access APIs.
# A consumer key that is revoked or pending cannot be used to access an API.
# Any access tokens associated with a revoked consumer key will remain
# active. However, Apigee hybrid checks the status of the consumer key and
# if set to `revoked` will not allow access to the API.
# @param [String] name
# 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``
# @param [String] action
# Approve or revoke the consumer key by setting this value to
# `approve` or `revoke`, respectively.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleProtobufEmpty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleProtobufEmpty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Creates a custom consumer key and secret for a developer app. This is
# particularly useful if you want to migrate existing consumer keys and
# secrets to Apigee hybrid from another system.
# Consumer keys and secrets can contain letters, numbers, underscores, and
# hyphens. No other special characters are allowed.
# **Note**: To avoid service disruptions, a consumer key and secret
# should not exceed 2 KBs each.
# After creating the consumer key and secret, associate the key with
# an API product using the
# UpdateDeveloperAppKey API.
# If a consumer key and secret already exist, you can keep them or
# delete them using the
# DeleteDeveloperAppKey API.
# @param [String] parent
# Parent of the developer app key. Use the following structure in your
# request:
# `organizations/`org`/developers/`developer_email`/apps`
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] google_cloud_apigee_v1_developer_app_key_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Deletes a developer attribute.
# @param [String] name
# Required. Name of the developer attribute. Use the following structure in your
# request:
# `organizations/`org`/developers/`developer_email`/attributes/`attribute``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Returns the value of the specified developer attribute.
# @param [String] name
# Required. Name of the developer attribute. Use the following structure in your
# request:
# `organizations/`org`/developers/`developer_email`/attributes/`attribute``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Returns a list of all developer attributes.
# @param [String] parent
# Required. Email address of the developer for which attributes are being listed
# in the
# following format:
# `organizations/`org`/developers/`developer_email``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [String] name
# Required. Name of the developer attribute. Use the following structure in your
# request:
# `organizations/`org`/developers/`developer_email`/attributes/`attribute``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] google_cloud_apigee_v1_attribute_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Creates an environment in an organization.
# @param [String] parent
# Required. Name of the organization in which the environment will
# be created. Use the following structure in your request:
# `organizations/`org``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment] google_cloud_apigee_v1_environment_object
# @param [String] name
# Optional. Name of the environment. Alternatively, the name may
# be specified in the request body in the
# environment_id field.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Deletes an environment from an organization.
# @param [String] name
# Required. Name of the environment. Use the following structure in your
# request:
# `organizations/`org`/environments/`env``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Gets environment details.
# @param [String] name
# Required. Name of the environment. Use the following structure in your request:
# `organizations/`org`/environments/`env``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Gets the debug mask singleton resource for an environment.
# @param [String] name
# Required. Name of the debug mask. Use the following structure in your request:
# `organizations/`org`/environments/`env`/debugmask`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Gets the deployed configuration for an environment.
# @param [String] name
# Required. Name of the environment deployed configuration resource. Use the
# following
# structure in your request:
# `organizations/`org`/environments/`env`/deployedConfig`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentConfig] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentConfig]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Gets the IAM policy on an environment. For more information, see
# [Manage users, roles, and permissions
# using the API](https://docs.apigee.com/hybrid/latest/manage-users-roles).
# You must have the `apigee.environments.getIamPolicy` permission to call
# this API.
# @param [String] resource
# REQUIRED: The resource for which the policy is being requested.
# See the operation documentation for the appropriate value for this field.
# @param [Fixnum] options_requested_policy_version
# Optional. The policy format version to be returned.
# Valid values are 0, 1, and 3. Requests specifying an invalid value will be
# rejected.
# Requests for policies with any conditional bindings must specify version 3.
# Policies without any conditional bindings may specify any valid value or
# leave the field unset.
# To learn which resources support conditions in their IAM policies, see the
# [IAM
# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleIamV1Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleIamV1Policy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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](https://docs.apigee.com/hybrid/latest/manage-users-roles).
# You must have the `apigee.environments.setIamPolicy` permission to
# call this API.
# @param [String] resource
# REQUIRED: The resource for which the policy is being specified.
# See the operation documentation for the appropriate value for this field.
# @param [Google::Apis::ApigeeV1::GoogleIamV1SetIamPolicyRequest] google_iam_v1_set_iam_policy_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleIamV1Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleIamV1Policy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [String] parent
# Required. Name of the environment. Use the following structure in your request:
# `organizations/`org`/environments/`env``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Subscription] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Subscription]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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).
# @param [String] resource
# REQUIRED: The resource for which the policy detail is being requested.
# See the operation documentation for the appropriate value for this field.
# @param [Google::Apis::ApigeeV1::GoogleIamV1TestIamPermissionsRequest] google_iam_v1_test_iam_permissions_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleIamV1TestIamPermissionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleIamV1TestIamPermissionsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Deletes a subscription for the environment's Pub/Sub topic.
# @param [String] parent
# Required. Name of the environment. Use the following structure in your request:
# `organizations/`org`/environments/`env``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Subscription] google_cloud_apigee_v1_subscription_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleProtobufEmpty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleProtobufEmpty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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](get).
# @param [String] name
# Required. Name of the environment. Use the following structure in your request:
# `organizations/`org`/environments/`env``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment] google_cloud_apigee_v1_environment_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Updates the debug mask singleton resource for an environment.
# @param [String] name
# Name of the debug mask.
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask] google_cloud_apigee_v1_debug_mask_object
# @param [Boolean] replace_repeated_fields
# 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).
# @param [String] update_mask
# Field debug mask to support partial updates.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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](get).
# @param [String] name
# Required. Name of the environment. Use the following structure in your request:
# `organizations/`org`/environments/`env``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment] google_cloud_apigee_v1_environment_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Get a list of metrics and dimensions which can be used for creating
# analytics queries and reports.
# Each schema element contains the name of the field with its associated type
# and if it is either custom field or standard field.
# @param [String] name
# Required. The parent organization and environment names. Must be of the
# form `organizations/`org`/environments/`env`/analytics/admin/schemav2`.
# @param [String] type
# Required. Type refers to the dataset name whose schema needs to be
# retrieved E.g. type=fact or type=agg_cus1
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Schema] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Schema]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_environment_analytic_admin_schemav2(name, type: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Schema::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Schema
command.params['name'] = name unless name.nil?
command.query['type'] = type unless type.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists all deployments of an API proxy in an environment.
# @param [String] parent
# Required. Name representing an API proxy in an environment in the following
# format:
# `organizations/`org`/environments/`env`/apis/`api``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Undeploys an API proxy revision from an environment.
# Because multiple revisions of the same API proxy can be deployed in
# the same environment if the base paths are different, you must specify the
# revision number of the API proxy.
# @param [String] name
# Required. Name of the API proxy revision deployment in the following format:
# `organizations/`org`/environments/`env`/apis/`api`/revisions/`rev``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleProtobufEmpty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleProtobufEmpty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def deployments_organization_environment_api_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
# Gets the deployment of an API proxy revision and actual state reported by
# runtime pods.
# @param [String] name
# Required. Name representing an API proxy revision in an
# environment in the following format:
# `organizations/`org`/environments/`env`/apis/`api`/revisions/`rev``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Creates a debug session for a deployed API Proxy revision.
# @param [String] parent
# 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``.
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSession] google_cloud_apigee_v1_debug_session_object
# @param [Fixnum] timeout
# Optional. The time in seconds after which this DebugSession should end.
# A timeout specified in DebugSession will overwrite this value.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSession] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSession]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [String] name
# Required. The name of the debug session to delete.
# Must be of the form:
# `organizations/`organization`/environments/`environment`/apis/`api`/revisions/
# `revision`/debugsessions/`debugsession``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleProtobufEmpty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleProtobufEmpty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Retrieves a debug session.
# @param [String] name
# Required. The name of the debug session to retrieve.
# Must be of the form:
# `organizations/`organization`/environments/`environment`/apis/`api`/revisions/
# `revision`/debugsessions/`session``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSession] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSession]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Lists debug sessions that are currently active in the given API Proxy
# revision.
# @param [String] parent
# 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``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDebugSessionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDebugSessionsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_environment_api_revision_debugsessions(parent, 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['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the debug data from a transaction.
# @param [String] name
# 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``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSessionTransaction] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSessionTransaction]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Deletes a cache.
# @param [String] name
# Required. Cache resource name of the form:
# `organizations/`organization_id`/environments/`environment_id`/caches/`
# cache_id``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleProtobufEmpty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleProtobufEmpty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Lists all deployments of API proxies or shared flows in an environment.
# @param [String] parent
# Required. Name of the environment for which to return deployment information
# in the
# following format:
# `organizations/`org`/environments/`env``
# @param [Boolean] shared_flows
# 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`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Attaches a shared flow to a flow hook.
# @param [String] name
# Required. Name of the flow hook to which the shared flow should be
# attached in the following format:
# `organizations/`org`/environments/`env`/flowhooks/`flowhook``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook] google_cloud_apigee_v1_flow_hook_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Detaches a shared flow from a flow hook.
# @param [String] name
# Required. Name of the flow hook to detach in the following format:
# `organizations/`org`/environments/`env`/flowhooks/`flowhook``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [String] name
# Required. Name of the flow hook in the following format:
# `organizations/`org`/environments/`env`/flowhooks/`flowhook``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [String] parent
# Required. The name of the environment in which to create the keystore.
# Must be of the form
# `organizations/`organization`/environments/`environment``.
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore] google_cloud_apigee_v1_keystore_object
# @param [String] name
# Optional. Overrides the value in Keystore.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Deletes a keystore or truststore.
# @param [String] name
# Required. The name of keystore to delete. Must be of the form
# `organizations/`organization`/environments/`environment`/keystores/`keystore``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Gets a keystore or truststore.
# @param [String] name
# Required. The name of keystore. Must be of the form
# `organizations/`organization`/environments/`environment`/keystores/`keystore``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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. The request must have `Content-Type: multipart/form-data` and
# include fields `keyFile` and `certFile`. If uploading to a truststore,
# omit `keyFile`.
# * `pkcs12` - A PKCS12 file is uploaded. The request must have
# `Content-Type: multipart/form-data` with the file provided in the only
# field.
# * `selfsignedcert` - A new private key and certificate are generated. The
# request must have `Content-Type: application/json` and a body of
# CertificateGenerationSpec.
# @param [String] parent
# Required. The name of the keystore. Must be of the form
# `organizations/`organization`/environments/`environment`/keystores/`keystore``.
# @param [Google::Apis::ApigeeV1::GoogleApiHttpBody] google_api_http_body_object
# @param [String] _password
# The password for the private key file, if it exists.
# @param [String] alias_
# The alias for the key, certificate pair. Values must match
# regular expression `[\w\s-.]`1,255``. This must be provided for all formats
# except 'selfsignedcert'; self-signed certs may specify the alias in either
# this parameter or the JSON body.
# @param [String] format
# Required. The format of the data. Must be either `selfsignedcert`,
# `keycertfile`, or `pkcs12`.
# @param [Boolean] ignore_expiry_validation
# If `true`, no expiry validation will be performed.
# @param [Boolean] ignore_newline_validation
# If `true`, do not throw an error when the file contains a chain with no
# newline between each certificate. By default, a newline is needed between
# each certificate in a chain.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Generates a PKCS #10 Certificate Signing Request for the private key in
# an alias.
# @param [String] name
# Required. The name of the alias. Must be of the form
# `organizations/`organization`/environments/`environment`/keystores/`keystore`/
# aliases/`alias``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleApiHttpBody] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleApiHttpBody]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Deletes an alias.
# @param [String] name
# Required. The name of the alias. Must be of the form
# `organizations/`organization`/environments/`environment`/keystores/`keystore`/
# aliases/`alias``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Gets an alias.
# @param [String] name
# Required. The name of the alias. Must be of the form
# `organizations/`organization`/environments/`environment`/keystores/`keystore`/
# aliases/`alias``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Gets the certificate from an alias in PEM-encoded form.
# @param [String] name
# Required. The name of the alias. Must be of the form
# `organizations/`organization`/environments/`environment`/keystores/`keystore`/
# aliases/`alias``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleApiHttpBody] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleApiHttpBody]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Updates the certificate in an alias.
# @param [String] name
# Required. The name of the alias. Must be of the form
# `organizations/`organization`/environments/`environment`/keystores/`keystore`/
# aliases/`alias``.
# @param [Google::Apis::ApigeeV1::GoogleApiHttpBody] google_api_http_body_object
# @param [Boolean] ignore_expiry_validation
# Required. If `true`, no expiry validation will be performed.
# @param [Boolean] ignore_newline_validation
# If `true`, do not throw an error when the file contains a chain with no
# newline between each certificate. By default, a newline is needed between
# each certificate in a chain.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Creates a key value map in an environment.
# @param [String] parent
# Required. The name of the environment in which to create the key value map.
# Must be of the form
# `organizations/`organization`/environments/`environment``.
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] google_cloud_apigee_v1_key_value_map_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Delete a key value map in an environment.
# @param [String] name
# Required. The name of the key value map.
# Must be of the form
# `organizations/`organization`/environments/`environment`/keyvaluemaps/`
# keyvaluemap``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# This api is similar to GetStats
# except that the response is less verbose.
# In the current scheme, a query parameter _optimized instructs
# Edge Analytics to change the response but since this behavior
# is not possible with protocol buffer and since this parameter is
# predominantly used by Edge UI, we are introducing a separate api.
# @param [String] name
# Required. The organization and environment name for which the interactive
# query will be executed. Must be of the form
# `organizations/`organization_id`/environments/`environment_id/stats/`
# dimensions``
# Dimensions let you view metrics in meaningful groupings. E.g. apiproxy,
# target_host. The value of dimensions should be comma separated list as
# shown below
# `organizations/`org`/environments/`env`/stats/apiproxy,request_verb`
# @param [String] accuracy
# Legacy field. not used anymore
# @param [String] agg_table
# If customers want to query custom aggregate tables, then this parameter
# can be used to specify the table name. If this parameter is skipped, then
# Edge Query will try to retrieve the data from fact tables which will be
# expensive.
# @param [String] filter
# Enables drill-down on specific dimension values
# @param [String] limit
# This parameter is used to limit the number of result items.
# Default and the max value is 14400
# @param [String] offset
# Use offset with limit to enable pagination of results. For example,
# to display results 11-20, set limit to '10' and offset to '10'.
# @param [Boolean] realtime
# Legacy field: not used anymore
# @param [String] select
# Required. The select parameter contains a comma separated list of metrics
# E.g. sum(message_count),sum(error_count)
# @param [Boolean] sonar
# This parameter routes the query to api monitoring service for last hour
# @param [String] sort
# This parameter specifies if the sort order should be ascending or
# descending Supported values are DESC and ASC.
# @param [String] sortby
# Comma separated list of columns to sort the final result.
# @param [String] time_range
# Required. Time interval for the interactive query.
# Time range is specified as start~end E.g. 04/15/2017 00:00~05/15/2017 23:59
# @param [String] time_unit
# A value of second, minute, hour, day, week, month.
# Time Unit specifies the granularity of metrics returned.
# @param [String] topk
# Take 'top k' results from results, for example, to return the top 5
# results 'topk=5'.
# @param [Boolean] ts_ascending
# Lists timestamps in ascending order if set to true. Recommend setting
# this value to true if you are using sortby with sort=DESC.
# @param [String] tzo
# This parameters contains the timezone offset value
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1OptimizedStats] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1OptimizedStats]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [String] parent
# Required. The parent organization and environment names.
# Must be of the form `organizations/`org`/environments/`env``.
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Query] google_cloud_apigee_v1_query_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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"
# @param [String] name
# Required. Name of the asynchronous query to get. Must be of the form
# `organizations/`org`/environments/`env`/queries/`queryId``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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-