API hub V1 API - Class Google::Cloud::ApiHub::V1::Version (v0.3.0)

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

Represents a version of the API resource in API hub. This is also referred to as the API version.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#accreditation

def accreditation() -> ::Google::Cloud::ApiHub::V1::AttributeValues
Returns
  • (::Google::Cloud::ApiHub::V1::AttributeValues) — Optional. The accreditations associated with the API version. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-accreditation 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.

#accreditation=

def accreditation=(value) -> ::Google::Cloud::ApiHub::V1::AttributeValues
Parameter
  • value (::Google::Cloud::ApiHub::V1::AttributeValues) — Optional. The accreditations associated with the API version. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-accreditation 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 accreditations associated with the API version. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-accreditation 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_operations

def api_operations() -> ::Array<::String>
Returns
  • (::Array<::String>) — Output only. The operations contained in the API version. These operations will be added to the version when a new spec is added or when an existing spec is updated. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}

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

#compliance

def compliance() -> ::Google::Cloud::ApiHub::V1::AttributeValues
Returns
  • (::Google::Cloud::ApiHub::V1::AttributeValues) — Optional. The compliance associated with the API version. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-compliance 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.

#compliance=

def compliance=(value) -> ::Google::Cloud::ApiHub::V1::AttributeValues
Parameter
  • value (::Google::Cloud::ApiHub::V1::AttributeValues) — Optional. The compliance associated with the API version. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-compliance 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 compliance associated with the API version. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-compliance 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

#definitions

def definitions() -> ::Array<::String>
Returns
  • (::Array<::String>) — Output only. The definitions contained in the API version. These definitions will be added to the version when a new spec is added or when an existing spec is updated. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}

#deployments

def deployments() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc) Format is projects/{project}/locations/{location}/deployments/{deployment}

#deployments=

def deployments=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc) Format is projects/{project}/locations/{location}/deployments/{deployment}
Returns
  • (::Array<::String>) — Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc) Format is projects/{project}/locations/{location}/deployments/{deployment}

#description

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

#description=

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

#display_name

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

#display_name=

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

#documentation

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

#documentation=

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

#lifecycle

def lifecycle() -> ::Google::Cloud::ApiHub::V1::AttributeValues
Returns
  • (::Google::Cloud::ApiHub::V1::AttributeValues) — Optional. The lifecycle of the API version. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-lifecycle 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.

#lifecycle=

def lifecycle=(value) -> ::Google::Cloud::ApiHub::V1::AttributeValues
Parameter
  • value (::Google::Cloud::ApiHub::V1::AttributeValues) — Optional. The lifecycle of the API version. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-lifecycle 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 lifecycle of the API version. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-lifecycle 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 version.

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

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Identifier. The name of the version.

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

Returns
  • (::String) — Identifier. The name of the version.

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

#selected_deployment

def selected_deployment() -> ::String
Returns
  • (::String) — Optional. The selected deployment for a Version resource. This can be used when special handling is needed on client side for a particular deployment linked to the version. Format is projects/{project}/locations/{location}/deployments/{deployment}

#selected_deployment=

def selected_deployment=(value) -> ::String
Parameter
  • value (::String) — Optional. The selected deployment for a Version resource. This can be used when special handling is needed on client side for a particular deployment linked to the version. Format is projects/{project}/locations/{location}/deployments/{deployment}
Returns
  • (::String) — Optional. The selected deployment for a Version resource. This can be used when special handling is needed on client side for a particular deployment linked to the version. Format is projects/{project}/locations/{location}/deployments/{deployment}

#specs

def specs() -> ::Array<::String>
Returns
  • (::Array<::String>) — Output only. The specs associated with this version. Note that an API version can be associated with multiple specs. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}

#update_time

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