Class: Google::Cloud::ApiHub::V1::Plugin

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/apihub/v1/plugin_service.rb

Overview

A plugin resource in the API Hub.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ ::String

Returns 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).



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'proto_docs/google/cloud/apihub/v1/plugin_service.rb', line 50

class Plugin
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible states a plugin can have. Note that this enum may receive new
  # values in the future. Consumers are advised to always code against the
  # enum values expecting new states can be added later on.
  module State
    # The default value. This value is used if the state is omitted.
    STATE_UNSPECIFIED = 0

    # The plugin is enabled.
    ENABLED = 1

    # The plugin is disabled.
    DISABLED = 2
  end
end

#display_name ⇒ ::String

Returns 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).



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'proto_docs/google/cloud/apihub/v1/plugin_service.rb', line 50

class Plugin
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible states a plugin can have. Note that this enum may receive new
  # values in the future. Consumers are advised to always code against the
  # enum values expecting new states can be added later on.
  module State
    # The default value. This value is used if the state is omitted.
    STATE_UNSPECIFIED = 0

    # The plugin is enabled.
    ENABLED = 1

    # The plugin is disabled.
    DISABLED = 2
  end
end

#name ⇒ ::String

Returns 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}



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'proto_docs/google/cloud/apihub/v1/plugin_service.rb', line 50

class Plugin
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible states a plugin can have. Note that this enum may receive new
  # values in the future. Consumers are advised to always code against the
  # enum values expecting new states can be added later on.
  module State
    # The default value. This value is used if the state is omitted.
    STATE_UNSPECIFIED = 0

    # The plugin is enabled.
    ENABLED = 1

    # The plugin is disabled.
    DISABLED = 2
  end
end

#state ⇒ ::Google::Cloud::ApiHub::V1::Plugin::State (readonly)

Returns Output only. Represents the state of the plugin.

Returns:



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'proto_docs/google/cloud/apihub/v1/plugin_service.rb', line 50

class Plugin
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible states a plugin can have. Note that this enum may receive new
  # values in the future. Consumers are advised to always code against the
  # enum values expecting new states can be added later on.
  module State
    # The default value. This value is used if the state is omitted.
    STATE_UNSPECIFIED = 0

    # The plugin is enabled.
    ENABLED = 1

    # The plugin is disabled.
    DISABLED = 2
  end
end

#type ⇒ ::Google::Cloud::ApiHub::V1::AttributeValues

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'proto_docs/google/cloud/apihub/v1/plugin_service.rb', line 50

class Plugin
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible states a plugin can have. Note that this enum may receive new
  # values in the future. Consumers are advised to always code against the
  # enum values expecting new states can be added later on.
  module State
    # The default value. This value is used if the state is omitted.
    STATE_UNSPECIFIED = 0

    # The plugin is enabled.
    ENABLED = 1

    # The plugin is disabled.
    DISABLED = 2
  end
end