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

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

Represents a definition for example schema, request, response definitions contained in an API version. A definition is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, definition will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec. Also, within OpenAPI spec, only schema object is supported.

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 definition 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 definition 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 definition 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

#name

def name() -> ::String
Returns
  • (::String) — Identifier. The name of the definition.

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

#name=

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

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

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

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

#schema

def schema() -> ::Google::Cloud::ApiHub::V1::Schema
Returns

#spec

def spec() -> ::String
Returns
  • (::String) — Output only. The name of the spec from where the definition was parsed. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}

#type

def type() -> ::Google::Cloud::ApiHub::V1::Definition::Type
Returns

#update_time

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