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

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

An API resource in the API Hub.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#api_style

def api_style() -> ::Google::Cloud::ApiHub::V1::AttributeValues
Returns
  • (::Google::Cloud::ApiHub::V1::AttributeValues) — Optional. The style of the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-api-style attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.

#api_style=

def api_style=(value) -> ::Google::Cloud::ApiHub::V1::AttributeValues
Parameter
  • value (::Google::Cloud::ApiHub::V1::AttributeValues) — Optional. The style of the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-api-style attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
Returns
  • (::Google::Cloud::ApiHub::V1::AttributeValues) — Optional. The style of the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-api-style attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.

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

#business_unit

def business_unit() -> ::Google::Cloud::ApiHub::V1::AttributeValues
Returns
  • (::Google::Cloud::ApiHub::V1::AttributeValues) — Optional. The business unit owning the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-business-unit attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.

#business_unit=

def business_unit=(value) -> ::Google::Cloud::ApiHub::V1::AttributeValues
Parameter
  • value (::Google::Cloud::ApiHub::V1::AttributeValues) — Optional. The business unit owning the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-business-unit attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
Returns
  • (::Google::Cloud::ApiHub::V1::AttributeValues) — Optional. The business unit owning the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-business-unit attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.

#create_time

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

#description

def description() -> ::String
Returns
  • (::String) — Optional. The description of the API resource.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. The description of the API resource.
Returns
  • (::String) — Optional. The description of the API resource.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Required. The display name of the API resource.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Required. The display name of the API resource.
Returns
  • (::String) — Required. The display name of the API resource.

#documentation

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

#documentation=

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

#maturity_level

def maturity_level() -> ::Google::Cloud::ApiHub::V1::AttributeValues
Returns
  • (::Google::Cloud::ApiHub::V1::AttributeValues) — Optional. The maturity level of the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-maturity-level attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.

#maturity_level=

def maturity_level=(value) -> ::Google::Cloud::ApiHub::V1::AttributeValues
Parameter
  • value (::Google::Cloud::ApiHub::V1::AttributeValues) — Optional. The maturity level of the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-maturity-level attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
Returns
  • (::Google::Cloud::ApiHub::V1::AttributeValues) — Optional. The maturity level of the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-maturity-level attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.

#name

def name() -> ::String
Returns
  • (::String) — Identifier. The name of the API resource in the API Hub.

    Format: projects/{project}/locations/{location}/apis/{api}

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Identifier. The name of the API resource in the API Hub.

    Format: projects/{project}/locations/{location}/apis/{api}

Returns
  • (::String) — Identifier. The name of the API resource in the API Hub.

    Format: projects/{project}/locations/{location}/apis/{api}

#owner

def owner() -> ::Google::Cloud::ApiHub::V1::Owner
Returns

#owner=

def owner=(value) -> ::Google::Cloud::ApiHub::V1::Owner
Parameter
Returns

#selected_version

def selected_version() -> ::String
Returns
  • (::String) — Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}

#selected_version=

def selected_version=(value) -> ::String
Parameter
  • value (::String) — Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}
Returns
  • (::String) — Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}

#target_user

def target_user() -> ::Google::Cloud::ApiHub::V1::AttributeValues
Returns
  • (::Google::Cloud::ApiHub::V1::AttributeValues) — Optional. The target users for the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-target-user attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.

#target_user=

def target_user=(value) -> ::Google::Cloud::ApiHub::V1::AttributeValues
Parameter
  • value (::Google::Cloud::ApiHub::V1::AttributeValues) — Optional. The target users for the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-target-user attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
Returns
  • (::Google::Cloud::ApiHub::V1::AttributeValues) — Optional. The target users for the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-target-user attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.

#team

def team() -> ::Google::Cloud::ApiHub::V1::AttributeValues
Returns
  • (::Google::Cloud::ApiHub::V1::AttributeValues) — Optional. The team owning the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-team attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.

#team=

def team=(value) -> ::Google::Cloud::ApiHub::V1::AttributeValues
Parameter
  • value (::Google::Cloud::ApiHub::V1::AttributeValues) — Optional. The team owning the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-team attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
Returns
  • (::Google::Cloud::ApiHub::V1::AttributeValues) — Optional. The team owning the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-team attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.

#update_time

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

#versions

def versions() -> ::Array<::String>
Returns
  • (::Array<::String>) — Output only. The list of versions present in an API resource. Note: An API resource can be associated with more than 1 version. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}