API hub V1 API - Class Google::Cloud::ApiHub::V1::ExternalApi (v0.2.0)

Reference documentation and code samples for the API hub V1 API class Google::Cloud::ApiHub::V1::ExternalApi.

An external API represents an API being provided by external sources. This can be used to model third-party APIs and can be used to define dependencies.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#attributes

def attributes() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::ApiHub::V1::AttributeValues}
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::ApiHub::V1::AttributeValues}) — Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: projects/{project}/locations/{location}/attributes/{attribute}. The value is the attribute values associated with the resource.

#attributes=

def attributes=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::ApiHub::V1::AttributeValues}
Parameter
  • value (::Google::Protobuf::Map{::String => ::Google::Cloud::ApiHub::V1::AttributeValues}) — Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: projects/{project}/locations/{location}/attributes/{attribute}. The value is the attribute values associated with the resource.
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::ApiHub::V1::AttributeValues}) — Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: projects/{project}/locations/{location}/attributes/{attribute}. The value is the attribute values associated with the resource.

#create_time

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

#description

def description() -> ::String
Returns
  • (::String) — Optional. Description of the external API. Max length is 2000 characters (Unicode Code Points).

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. Description of the external API. Max length is 2000 characters (Unicode Code Points).
Returns
  • (::String) — Optional. Description of the external API. Max length is 2000 characters (Unicode Code Points).

#display_name

def display_name() -> ::String
Returns
  • (::String) — Required. Display name of the external API. Max length is 63 characters (Unicode Code Points).

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Required. Display name of the external API. Max length is 63 characters (Unicode Code Points).
Returns
  • (::String) — Required. Display name of the external API. Max length is 63 characters (Unicode Code Points).

#documentation

def documentation() -> ::Google::Cloud::ApiHub::V1::Documentation
Returns

#documentation=

def documentation=(value) -> ::Google::Cloud::ApiHub::V1::Documentation
Parameter
Returns

#endpoints

def endpoints() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. List of endpoints on which this API is accessible.

#endpoints=

def endpoints=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Optional. List of endpoints on which this API is accessible.
Returns
  • (::Array<::String>) — Optional. List of endpoints on which this API is accessible.

#name

def name() -> ::String
Returns
  • (::String) — Identifier. Format: projects/{project}/locations/{location}/externalApi/{externalApi}.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Identifier. Format: projects/{project}/locations/{location}/externalApi/{externalApi}.
Returns
  • (::String) — Identifier. Format: projects/{project}/locations/{location}/externalApi/{externalApi}.

#paths

def paths() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. List of paths served by this API.

#paths=

def paths=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Optional. List of paths served by this API.
Returns
  • (::Array<::String>) — Optional. List of paths served by this API.

#update_time

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