Apigee Registry V1 API - Class Google::Cloud::ApigeeRegistry::V1::ApiDeployment (v0.1.0)

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

An ApiDeployment describes a service running at particular address that provides a particular version of an API. ApiDeployments have revisions which correspond to different configurations of a single deployment in time. Revision identifiers should be updated whenever the served API spec or endpoint address changes.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#access_guidance

def access_guidance() -> ::String
Returns
  • (::String) — Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.

#access_guidance=

def access_guidance=(value) -> ::String
Parameter
  • value (::String) — Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.
Returns
  • (::String) — Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.

#annotations

def annotations() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Annotations attach non-identifying metadata to resources.

    Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.

#annotations=

def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Annotations attach non-identifying metadata to resources.

    Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.

Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Annotations attach non-identifying metadata to resources.

    Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.

#api_spec_revision

def api_spec_revision() -> ::String
Returns
  • (::String) — The full resource name (including revision id) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: apis/{api}/deployments/{deployment}

#api_spec_revision=

def api_spec_revision=(value) -> ::String
Parameter
  • value (::String) — The full resource name (including revision id) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: apis/{api}/deployments/{deployment}
Returns
  • (::String) — The full resource name (including revision id) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: apis/{api}/deployments/{deployment}

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#description

def description() -> ::String
Returns
  • (::String) — A detailed description.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — A detailed description.
Returns
  • (::String) — A detailed description.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Human-meaningful name.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Human-meaningful name.
Returns
  • (::String) — Human-meaningful name.

#endpoint_uri

def endpoint_uri() -> ::String
Returns
  • (::String) — The address where the deployment is serving. Changes to this value will update the revision.

#endpoint_uri=

def endpoint_uri=(value) -> ::String
Parameter
  • value (::String) — The address where the deployment is serving. Changes to this value will update the revision.
Returns
  • (::String) — The address where the deployment is serving. Changes to this value will update the revision.

#external_channel_uri

def external_channel_uri() -> ::String
Returns
  • (::String) — The address of the external channel of the API (e.g. the Developer Portal). Changes to this value will not affect the revision.

#external_channel_uri=

def external_channel_uri=(value) -> ::String
Parameter
  • value (::String) — The address of the external channel of the API (e.g. the Developer Portal). Changes to this value will not affect the revision.
Returns
  • (::String) — The address of the external channel of the API (e.g. the Developer Portal). Changes to this value will not affect the revision.

#intended_audience

def intended_audience() -> ::String
Returns
  • (::String) — Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.

#intended_audience=

def intended_audience=(value) -> ::String
Parameter
  • value (::String) — Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.
Returns
  • (::String) — Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations.

    Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded).

    See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "apigeeregistry.googleapis.com/" and cannot be changed.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations.

    Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded).

    See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "apigeeregistry.googleapis.com/" and cannot be changed.

Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations.

    Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded).

    See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "apigeeregistry.googleapis.com/" and cannot be changed.

#name

def name() -> ::String
Returns
  • (::String) — Resource name.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Resource name.
Returns
  • (::String) — Resource name.

#revision_create_time

def revision_create_time() -> ::Google::Protobuf::Timestamp
Returns

#revision_id

def revision_id() -> ::String
Returns
  • (::String) — Output only. Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string.

#revision_update_time

def revision_update_time() -> ::Google::Protobuf::Timestamp
Returns