Apigee Registry V1 API - Class Google::Cloud::ApigeeRegistry::V1::Api (v0.3.1)

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

A top-level description of an API. Produced by producers and are commitments to provide services.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

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

#availability

def availability() -> ::String
Returns
  • (::String) — A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g., "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".

#availability=

def availability=(value) -> ::String
Parameter
  • value (::String) — A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g., "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".
Returns
  • (::String) — A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g., "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".

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

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

#recommended_deployment

def recommended_deployment() -> ::String
Returns
  • (::String) — The recommended deployment of the API. Format: apis/{api}/deployments/{deployment}

#recommended_deployment=

def recommended_deployment=(value) -> ::String
Parameter
  • value (::String) — The recommended deployment of the API. Format: apis/{api}/deployments/{deployment}
Returns
  • (::String) — The recommended deployment of the API. Format: apis/{api}/deployments/{deployment}

#recommended_version

def recommended_version() -> ::String
Returns
  • (::String) — The recommended version of the API. Format: apis/{api}/versions/{version}

#recommended_version=

def recommended_version=(value) -> ::String
Parameter
  • value (::String) — The recommended version of the API. Format: apis/{api}/versions/{version}
Returns
  • (::String) — The recommended version of the API. Format: apis/{api}/versions/{version}

#update_time

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