Apigee Registry V1 API - Class Google::Cloud::ApigeeRegistry::V1::Registry::Rest::Client (v0.5.0)

Reference documentation and code samples for the Apigee Registry V1 API class Google::Cloud::ApigeeRegistry::V1::Registry::Rest::Client.

REST client for the Registry service.

The Registry service allows teams to manage descriptions of APIs.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the Registry Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all Registry clients
::Google::Cloud::ApigeeRegistry::V1::Registry::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the Registry Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#create_api

def create_api(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::Api
def create_api(parent: nil, api: nil, api_id: nil) -> ::Google::Cloud::ApigeeRegistry::V1::Api

Creates a specified API.

Overloads 
def create_api(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::Api
Pass arguments to create_api via a request object, either of type CreateApiRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::CreateApiRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_api(parent: nil, api: nil, api_id: nil) -> ::Google::Cloud::ApigeeRegistry::V1::Api
Pass arguments to create_api via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent, which owns this collection of APIs. Format: projects/*/locations/*
  • api (::Google::Cloud::ApigeeRegistry::V1::Api, ::Hash) — Required. The API to create.
  • api_id (::String) — Required. The ID to use for the API, which will become the final component of the API's resource name.

    This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

    Following AIP-162, IDs must not have the form of a UUID.

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#create_api_deployment

def create_api_deployment(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment
def create_api_deployment(parent: nil, api_deployment: nil, api_deployment_id: nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment

Creates a specified deployment.

Overloads 
def create_api_deployment(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment
Pass arguments to create_api_deployment via a request object, either of type CreateApiDeploymentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::CreateApiDeploymentRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_api_deployment(parent: nil, api_deployment: nil, api_deployment_id: nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment
Pass arguments to create_api_deployment via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent, which owns this collection of deployments. Format: projects/*/locations/*/apis/*
  • api_deployment (::Google::Cloud::ApigeeRegistry::V1::ApiDeployment, ::Hash) — Required. The deployment to create.
  • api_deployment_id (::String) — Required. The ID to use for the deployment, which will become the final component of the deployment's resource name.

    This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

    Following AIP-162, IDs must not have the form of a UUID.

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#create_api_spec

def create_api_spec(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiSpec
def create_api_spec(parent: nil, api_spec: nil, api_spec_id: nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiSpec

Creates a specified spec.

Overloads 
def create_api_spec(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiSpec
Pass arguments to create_api_spec via a request object, either of type CreateApiSpecRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::CreateApiSpecRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_api_spec(parent: nil, api_spec: nil, api_spec_id: nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiSpec
Pass arguments to create_api_spec via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent, which owns this collection of specs. Format: projects/*/locations/*/apis/*/versions/*
  • api_spec (::Google::Cloud::ApigeeRegistry::V1::ApiSpec, ::Hash) — Required. The spec to create.
  • api_spec_id (::String) — Required. The ID to use for the spec, which will become the final component of the spec's resource name.

    This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

    Following AIP-162, IDs must not have the form of a UUID.

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#create_api_version

def create_api_version(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiVersion
def create_api_version(parent: nil, api_version: nil, api_version_id: nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiVersion

Creates a specified version.

Overloads 
def create_api_version(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiVersion
Pass arguments to create_api_version via a request object, either of type CreateApiVersionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::CreateApiVersionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_api_version(parent: nil, api_version: nil, api_version_id: nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiVersion
Pass arguments to create_api_version via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent, which owns this collection of versions. Format: projects/*/locations/*/apis/*
  • api_version (::Google::Cloud::ApigeeRegistry::V1::ApiVersion, ::Hash) — Required. The version to create.
  • api_version_id (::String) — Required. The ID to use for the version, which will become the final component of the version's resource name.

    This value should be 1-63 characters, and valid characters are /[a-z][0-9]-/.

    Following AIP-162, IDs must not have the form of a UUID.

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#create_artifact

def create_artifact(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::Artifact
def create_artifact(parent: nil, artifact: nil, artifact_id: nil) -> ::Google::Cloud::ApigeeRegistry::V1::Artifact

Creates a specified artifact.

Overloads 
def create_artifact(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::Artifact
Pass arguments to create_artifact via a request object, either of type CreateArtifactRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::CreateArtifactRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_artifact(parent: nil, artifact: nil, artifact_id: nil) -> ::Google::Cloud::ApigeeRegistry::V1::Artifact
Pass arguments to create_artifact via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent, which owns this collection of artifacts. Format: {parent}
  • artifact (::Google::Cloud::ApigeeRegistry::V1::Artifact, ::Hash) — Required. The artifact to create.
  • artifact_id (::String) — Required. The ID to use for the artifact, which will become the final component of the artifact's resource name.

    This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

    Following AIP-162, IDs must not have the form of a UUID.

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#delete_api

def delete_api(request, options = nil) -> ::Google::Protobuf::Empty
def delete_api(name: nil, force: nil) -> ::Google::Protobuf::Empty

Removes a specified API and all of the resources that it owns.

Overloads 
def delete_api(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_api via a request object, either of type DeleteApiRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::DeleteApiRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_api(name: nil, force: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_api via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the API to delete. Format: projects/*/locations/*/apis/*
  • force (::Boolean) — If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#delete_api_deployment

def delete_api_deployment(request, options = nil) -> ::Google::Protobuf::Empty
def delete_api_deployment(name: nil, force: nil) -> ::Google::Protobuf::Empty

Removes a specified deployment, all revisions, and all child resources (e.g., artifacts).

Overloads 
def delete_api_deployment(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_api_deployment via a request object, either of type DeleteApiDeploymentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::DeleteApiDeploymentRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_api_deployment(name: nil, force: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_api_deployment via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the deployment to delete. Format: projects/*/locations/*/apis/*/deployments/*
  • force (::Boolean) — If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#delete_api_deployment_revision

def delete_api_deployment_revision(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment
def delete_api_deployment_revision(name: nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment

Deletes a revision of a deployment.

Overloads 
def delete_api_deployment_revision(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment
Pass arguments to delete_api_deployment_revision via a request object, either of type DeleteApiDeploymentRevisionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::DeleteApiDeploymentRevisionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_api_deployment_revision(name: nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment
Pass arguments to delete_api_deployment_revision via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the deployment revision to be deleted, with a revision ID explicitly included.

    Example: projects/sample/locations/global/apis/petstore/deployments/prod@c7cfa2a8

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#delete_api_spec

def delete_api_spec(request, options = nil) -> ::Google::Protobuf::Empty
def delete_api_spec(name: nil, force: nil) -> ::Google::Protobuf::Empty

Removes a specified spec, all revisions, and all child resources (e.g., artifacts).

Overloads 
def delete_api_spec(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_api_spec via a request object, either of type DeleteApiSpecRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::DeleteApiSpecRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_api_spec(name: nil, force: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_api_spec via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the spec to delete. Format: projects/*/locations/*/apis/*/versions/*/specs/*
  • force (::Boolean) — If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#delete_api_spec_revision

def delete_api_spec_revision(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiSpec
def delete_api_spec_revision(name: nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiSpec

Deletes a revision of a spec.

Overloads 
def delete_api_spec_revision(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiSpec
Pass arguments to delete_api_spec_revision via a request object, either of type DeleteApiSpecRevisionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::DeleteApiSpecRevisionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_api_spec_revision(name: nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiSpec
Pass arguments to delete_api_spec_revision via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the spec revision to be deleted, with a revision ID explicitly included.

    Example: projects/sample/locations/global/apis/petstore/versions/1.0.0/specs/openapi.yaml@c7cfa2a8

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#delete_api_version

def delete_api_version(request, options = nil) -> ::Google::Protobuf::Empty
def delete_api_version(name: nil, force: nil) -> ::Google::Protobuf::Empty

Removes a specified version and all of the resources that it owns.

Overloads 
def delete_api_version(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_api_version via a request object, either of type DeleteApiVersionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::DeleteApiVersionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_api_version(name: nil, force: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_api_version via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the version to delete. Format: projects/*/locations/*/apis/*/versions/*
  • force (::Boolean) — If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#delete_artifact

def delete_artifact(request, options = nil) -> ::Google::Protobuf::Empty
def delete_artifact(name: nil) -> ::Google::Protobuf::Empty

Removes a specified artifact.

Overloads 
def delete_artifact(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_artifact via a request object, either of type DeleteArtifactRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::DeleteArtifactRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_artifact(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_artifact via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the artifact to delete. Format: {parent}/artifacts/*
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#get_api

def get_api(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::Api
def get_api(name: nil) -> ::Google::Cloud::ApigeeRegistry::V1::Api

Returns a specified API.

Overloads 
def get_api(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::Api
Pass arguments to get_api via a request object, either of type GetApiRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::GetApiRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_api(name: nil) -> ::Google::Cloud::ApigeeRegistry::V1::Api
Pass arguments to get_api via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the API to retrieve. Format: projects/*/locations/*/apis/*
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#get_api_deployment

def get_api_deployment(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment
def get_api_deployment(name: nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment

Returns a specified deployment.

Overloads 
def get_api_deployment(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment
Pass arguments to get_api_deployment via a request object, either of type GetApiDeploymentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::GetApiDeploymentRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_api_deployment(name: nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment
Pass arguments to get_api_deployment via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the deployment to retrieve. Format: projects/*/locations/*/apis/*/deployments/*
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#get_api_spec

def get_api_spec(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiSpec
def get_api_spec(name: nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiSpec

Returns a specified spec.

Overloads 
def get_api_spec(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiSpec
Pass arguments to get_api_spec via a request object, either of type GetApiSpecRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::GetApiSpecRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_api_spec(name: nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiSpec
Pass arguments to get_api_spec via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the spec to retrieve. Format: projects/*/locations/*/apis/*/versions/*/specs/*
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#get_api_spec_contents

def get_api_spec_contents(request, options = nil) -> ::Google::Api::HttpBody
def get_api_spec_contents(name: nil) -> ::Google::Api::HttpBody

Returns the contents of a specified spec. If specs are stored with GZip compression, the default behavior is to return the spec uncompressed (the mime_type response field indicates the exact format returned).

Overloads 
def get_api_spec_contents(request, options = nil) -> ::Google::Api::HttpBody
Pass arguments to get_api_spec_contents via a request object, either of type GetApiSpecContentsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::GetApiSpecContentsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_api_spec_contents(name: nil) -> ::Google::Api::HttpBody
Pass arguments to get_api_spec_contents via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the spec whose contents should be retrieved. Format: projects/*/locations/*/apis/*/versions/*/specs/*
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#get_api_version

def get_api_version(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiVersion
def get_api_version(name: nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiVersion

Returns a specified version.

Overloads 
def get_api_version(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiVersion
Pass arguments to get_api_version via a request object, either of type GetApiVersionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::GetApiVersionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_api_version(name: nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiVersion
Pass arguments to get_api_version via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the version to retrieve. Format: projects/*/locations/*/apis/*/versions/*
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#get_artifact

def get_artifact(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::Artifact
def get_artifact(name: nil) -> ::Google::Cloud::ApigeeRegistry::V1::Artifact

Returns a specified artifact.

Overloads 
def get_artifact(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::Artifact
Pass arguments to get_artifact via a request object, either of type GetArtifactRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::GetArtifactRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_artifact(name: nil) -> ::Google::Cloud::ApigeeRegistry::V1::Artifact
Pass arguments to get_artifact via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the artifact to retrieve. Format: {parent}/artifacts/*
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#get_artifact_contents

def get_artifact_contents(request, options = nil) -> ::Google::Api::HttpBody
def get_artifact_contents(name: nil) -> ::Google::Api::HttpBody

Returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned).

Overloads 
def get_artifact_contents(request, options = nil) -> ::Google::Api::HttpBody
Pass arguments to get_artifact_contents via a request object, either of type GetArtifactContentsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::GetArtifactContentsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_artifact_contents(name: nil) -> ::Google::Api::HttpBody
Pass arguments to get_artifact_contents via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the artifact whose contents should be retrieved. Format: {parent}/artifacts/*
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#iam_policy_client

def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Rest::Client

Get the associated client for mix-in of the IAMPolicy.

Returns
  • (Google::Iam::V1::IAMPolicy::Rest::Client)

#initialize

def initialize() { |config| ... } -> Client

Create a new Registry REST client object.

Yields
  • (config) — Configure the Registry client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::ApigeeRegistry::V1::Registry::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::ApigeeRegistry::V1::Registry::Rest::Client.new do |config|
  config.timeout = 10.0
end

#list_api_deployment_revisions

def list_api_deployment_revisions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiDeployment>
def list_api_deployment_revisions(name: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiDeployment>

Lists all revisions of a deployment. Revisions are returned in descending order of revision creation time.

Overloads 
def list_api_deployment_revisions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiDeployment>
Pass arguments to list_api_deployment_revisions via a request object, either of type ListApiDeploymentRevisionsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::ListApiDeploymentRevisionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_api_deployment_revisions(name: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiDeployment>
Pass arguments to list_api_deployment_revisions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the deployment to list revisions for.
  • page_size (::Integer) — The maximum number of revisions to return per page.
  • page_token (::String) — The page token, received from a previous ListApiDeploymentRevisions call. Provide this to retrieve the subsequent page.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#list_api_deployments

def list_api_deployments(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiDeployment>
def list_api_deployments(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiDeployment>

Returns matching deployments.

Overloads 
def list_api_deployments(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiDeployment>
Pass arguments to list_api_deployments via a request object, either of type ListApiDeploymentsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::ListApiDeploymentsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_api_deployments(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiDeployment>
Pass arguments to list_api_deployments via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent, which owns this collection of deployments. Format: projects/*/locations/*/apis/*
  • page_size (::Integer) — The maximum number of deployments to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — A page token, received from a previous ListApiDeployments call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to ListApiDeployments must match the call that provided the page token.

  • filter (::String) — An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#list_api_spec_revisions

def list_api_spec_revisions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiSpec>
def list_api_spec_revisions(name: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiSpec>

Lists all revisions of a spec. Revisions are returned in descending order of revision creation time.

Overloads 
def list_api_spec_revisions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiSpec>
Pass arguments to list_api_spec_revisions via a request object, either of type ListApiSpecRevisionsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::ListApiSpecRevisionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_api_spec_revisions(name: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiSpec>
Pass arguments to list_api_spec_revisions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the spec to list revisions for.
  • page_size (::Integer) — The maximum number of revisions to return per page.
  • page_token (::String) — The page token, received from a previous ListApiSpecRevisions call. Provide this to retrieve the subsequent page.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#list_api_specs

def list_api_specs(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiSpec>
def list_api_specs(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiSpec>

Returns matching specs.

Overloads 
def list_api_specs(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiSpec>
Pass arguments to list_api_specs via a request object, either of type ListApiSpecsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::ListApiSpecsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_api_specs(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiSpec>
Pass arguments to list_api_specs via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent, which owns this collection of specs. Format: projects/*/locations/*/apis/*/versions/*
  • page_size (::Integer) — The maximum number of specs to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — A page token, received from a previous ListApiSpecs call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to ListApiSpecs must match the call that provided the page token.

  • filter (::String) — An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#list_api_versions

def list_api_versions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiVersion>
def list_api_versions(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiVersion>

Returns matching versions.

Overloads 
def list_api_versions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiVersion>
Pass arguments to list_api_versions via a request object, either of type ListApiVersionsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::ListApiVersionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_api_versions(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiVersion>
Pass arguments to list_api_versions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent, which owns this collection of versions. Format: projects/*/locations/*/apis/*
  • page_size (::Integer) — The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — A page token, received from a previous ListApiVersions call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to ListApiVersions must match the call that provided the page token.

  • filter (::String) — An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#list_apis

def list_apis(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::Api>
def list_apis(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::Api>

Returns matching APIs.

Overloads 
def list_apis(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::Api>
Pass arguments to list_apis via a request object, either of type ListApisRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::ListApisRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_apis(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::Api>
Pass arguments to list_apis via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent, which owns this collection of APIs. Format: projects/*/locations/*
  • page_size (::Integer) — The maximum number of APIs to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — A page token, received from a previous ListApis call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to ListApis must match the call that provided the page token.

  • filter (::String) — An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#list_artifacts

def list_artifacts(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::Artifact>
def list_artifacts(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::Artifact>

Returns matching artifacts.

Overloads 
def list_artifacts(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::Artifact>
Pass arguments to list_artifacts via a request object, either of type ListArtifactsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::ListArtifactsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_artifacts(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::Artifact>
Pass arguments to list_artifacts via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent, which owns this collection of artifacts. Format: {parent}
  • page_size (::Integer) — The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — A page token, received from a previous ListArtifacts call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to ListArtifacts must match the call that provided the page token.

  • filter (::String) — An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#location_client

def location_client() -> Google::Cloud::Location::Locations::Rest::Client

Get the associated client for mix-in of the Locations.

Returns
  • (Google::Cloud::Location::Locations::Rest::Client)

#replace_artifact

def replace_artifact(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::Artifact
def replace_artifact(artifact: nil) -> ::Google::Cloud::ApigeeRegistry::V1::Artifact

Used to replace a specified artifact.

Overloads 
def replace_artifact(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::Artifact
Pass arguments to replace_artifact via a request object, either of type Google::Cloud::ApigeeRegistry::V1::ReplaceArtifactRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::ReplaceArtifactRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def replace_artifact(artifact: nil) -> ::Google::Cloud::ApigeeRegistry::V1::Artifact
Pass arguments to replace_artifact via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#rollback_api_deployment

def rollback_api_deployment(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment
def rollback_api_deployment(name: nil, revision_id: nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment

Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID.

Overloads 
def rollback_api_deployment(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment
Pass arguments to rollback_api_deployment via a request object, either of type Google::Cloud::ApigeeRegistry::V1::RollbackApiDeploymentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::RollbackApiDeploymentRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def rollback_api_deployment(name: nil, revision_id: nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment
Pass arguments to rollback_api_deployment via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The deployment being rolled back.
  • revision_id (::String) — Required. The revision ID to roll back to. It must be a revision of the same deployment.

    Example: c7cfa2a8

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#rollback_api_spec

def rollback_api_spec(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiSpec
def rollback_api_spec(name: nil, revision_id: nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiSpec

Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID.

Overloads 
def rollback_api_spec(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiSpec
Pass arguments to rollback_api_spec via a request object, either of type Google::Cloud::ApigeeRegistry::V1::RollbackApiSpecRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::RollbackApiSpecRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def rollback_api_spec(name: nil, revision_id: nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiSpec
Pass arguments to rollback_api_spec via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The spec being rolled back.
  • revision_id (::String) — Required. The revision ID to roll back to. It must be a revision of the same spec.

    Example: c7cfa2a8

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#tag_api_deployment_revision

def tag_api_deployment_revision(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment
def tag_api_deployment_revision(name: nil, tag: nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment

Adds a tag to a specified revision of a deployment.

Overloads 
def tag_api_deployment_revision(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment
Pass arguments to tag_api_deployment_revision via a request object, either of type TagApiDeploymentRevisionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::TagApiDeploymentRevisionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def tag_api_deployment_revision(name: nil, tag: nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment
Pass arguments to tag_api_deployment_revision via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the deployment to be tagged, including the revision ID.
  • tag (::String) — Required. The tag to apply. The tag should be at most 40 characters, and match [a-z][a-z0-9-]{3,39}.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#tag_api_spec_revision

def tag_api_spec_revision(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiSpec
def tag_api_spec_revision(name: nil, tag: nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiSpec

Adds a tag to a specified revision of a spec.

Overloads 
def tag_api_spec_revision(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiSpec
Pass arguments to tag_api_spec_revision via a request object, either of type TagApiSpecRevisionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::TagApiSpecRevisionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def tag_api_spec_revision(name: nil, tag: nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiSpec
Pass arguments to tag_api_spec_revision via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the spec to be tagged, including the revision ID.
  • tag (::String) — Required. The tag to apply. The tag should be at most 40 characters, and match [a-z][a-z0-9-]{3,39}.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#update_api

def update_api(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::Api
def update_api(api: nil, update_mask: nil, allow_missing: nil) -> ::Google::Cloud::ApigeeRegistry::V1::Api

Used to modify a specified API.

Overloads 
def update_api(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::Api
Pass arguments to update_api via a request object, either of type UpdateApiRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::UpdateApiRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def update_api(api: nil, update_mask: nil, allow_missing: nil) -> ::Google::Cloud::ApigeeRegistry::V1::Api
Pass arguments to update_api via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • api (::Google::Cloud::ApigeeRegistry::V1::Api, ::Hash) — Required. The API to update.

    The name field is used to identify the API to update. Format: projects/*/locations/*/apis/*

  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request.
  • allow_missing (::Boolean) — If set to true, and the API is not found, a new API will be created. In this situation, update_mask is ignored.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#update_api_deployment

def update_api_deployment(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment
def update_api_deployment(api_deployment: nil, update_mask: nil, allow_missing: nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment

Used to modify a specified deployment.

Overloads 
def update_api_deployment(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment
Pass arguments to update_api_deployment via a request object, either of type UpdateApiDeploymentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::UpdateApiDeploymentRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def update_api_deployment(api_deployment: nil, update_mask: nil, allow_missing: nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment
Pass arguments to update_api_deployment via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • api_deployment (::Google::Cloud::ApigeeRegistry::V1::ApiDeployment, ::Hash) — Required. The deployment to update.

    The name field is used to identify the deployment to update. Format: projects/*/locations/*/apis/*/deployments/*

  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request.
  • allow_missing (::Boolean) — If set to true, and the deployment is not found, a new deployment will be created. In this situation, update_mask is ignored.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#update_api_spec

def update_api_spec(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiSpec
def update_api_spec(api_spec: nil, update_mask: nil, allow_missing: nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiSpec

Used to modify a specified spec.

Overloads 
def update_api_spec(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiSpec
Pass arguments to update_api_spec via a request object, either of type UpdateApiSpecRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::UpdateApiSpecRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def update_api_spec(api_spec: nil, update_mask: nil, allow_missing: nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiSpec
Pass arguments to update_api_spec via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • api_spec (::Google::Cloud::ApigeeRegistry::V1::ApiSpec, ::Hash) — Required. The spec to update.

    The name field is used to identify the spec to update. Format: projects/*/locations/*/apis/*/versions/*/specs/*

  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request.
  • allow_missing (::Boolean) — If set to true, and the spec is not found, a new spec will be created. In this situation, update_mask is ignored.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#update_api_version

def update_api_version(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiVersion
def update_api_version(api_version: nil, update_mask: nil, allow_missing: nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiVersion

Used to modify a specified version.

Overloads 
def update_api_version(request, options = nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiVersion
Pass arguments to update_api_version via a request object, either of type UpdateApiVersionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeRegistry::V1::UpdateApiVersionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def update_api_version(api_version: nil, update_mask: nil, allow_missing: nil) -> ::Google::Cloud::ApigeeRegistry::V1::ApiVersion
Pass arguments to update_api_version via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • api_version (::Google::Cloud::ApigeeRegistry::V1::ApiVersion, ::Hash) — Required. The version to update.

    The name field is used to identify the version to update. Format: projects/*/locations/*/apis/*/versions/*

  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request.
  • allow_missing (::Boolean) — If set to true, and the version is not found, a new version will be created. In this situation, update_mask is ignored.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.