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

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

Represents a spec associated with an API version in the API Hub. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently.

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

#contents

def contents() -> ::Google::Cloud::ApiHub::V1::SpecContents
Returns

#contents=

def contents=(value) -> ::Google::Cloud::ApiHub::V1::SpecContents
Parameter
Returns

#create_time

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

#details

def details() -> ::Google::Cloud::ApiHub::V1::SpecDetails
Returns

#display_name

def display_name() -> ::String
Returns
  • (::String) — Required. The display name of the spec. This can contain the file name of the spec.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Required. The display name of the spec. This can contain the file name of the spec.
Returns
  • (::String) — Required. The display name of the spec. This can contain the file name of the spec.

#documentation

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

#documentation=

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

#lint_response

def lint_response() -> ::Google::Cloud::ApiHub::V1::LintResponse
Returns

#lint_response=

def lint_response=(value) -> ::Google::Cloud::ApiHub::V1::LintResponse
Parameter
Returns

#name

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

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

#name=

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

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

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

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

#parsing_mode

def parsing_mode() -> ::Google::Cloud::ApiHub::V1::Spec::ParsingMode
Returns

#parsing_mode=

def parsing_mode=(value) -> ::Google::Cloud::ApiHub::V1::Spec::ParsingMode
Parameter
Returns

#source_uri

def source_uri() -> ::String
Returns
  • (::String) — Optional. The URI of the spec source in case file is uploaded from an external version control system.

#source_uri=

def source_uri=(value) -> ::String
Parameter
  • value (::String) — Optional. The URI of the spec source in case file is uploaded from an external version control system.
Returns
  • (::String) — Optional. The URI of the spec source in case file is uploaded from an external version control system.

#spec_type

def spec_type() -> ::Google::Cloud::ApiHub::V1::AttributeValues
Returns
  • (::Google::Cloud::ApiHub::V1::AttributeValues) — Required. The type of spec. The value should be one of the allowed values defined for projects/{project}/locations/{location}/attributes/system-spec-type 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.

    Note, this field is mandatory if content is provided.

#spec_type=

def spec_type=(value) -> ::Google::Cloud::ApiHub::V1::AttributeValues
Parameter
  • value (::Google::Cloud::ApiHub::V1::AttributeValues) — Required. The type of spec. The value should be one of the allowed values defined for projects/{project}/locations/{location}/attributes/system-spec-type 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.

    Note, this field is mandatory if content is provided.

Returns
  • (::Google::Cloud::ApiHub::V1::AttributeValues) — Required. The type of spec. The value should be one of the allowed values defined for projects/{project}/locations/{location}/attributes/system-spec-type 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.

    Note, this field is mandatory if content is provided.

#update_time

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