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

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

A plugin resource in the API Hub.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#description

def description() -> ::String
Returns
  • (::String) — Optional. The plugin description. Max length is 2000 characters (Unicode code points).

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. The plugin description. Max length is 2000 characters (Unicode code points).
Returns
  • (::String) — Optional. The plugin description. Max length is 2000 characters (Unicode code points).

#display_name

def display_name() -> ::String
Returns
  • (::String) — Required. The display name of the plugin. Max length is 50 characters (Unicode code points).

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Required. The display name of the plugin. Max length is 50 characters (Unicode code points).
Returns
  • (::String) — Required. The display name of the plugin. Max length is 50 characters (Unicode code points).

#name

def name() -> ::String
Returns
  • (::String) — Identifier. The name of the plugin. Format: projects/{project}/locations/{location}/plugins/{plugin}

#name=

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

#state

def state() -> ::Google::Cloud::ApiHub::V1::Plugin::State
Returns

#type

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

#type=

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