Class: Gapic::Schema::Enum

Inherits:

Proto

• Object
• Proto
• Gapic::Schema::Enum

Extended by:

Forwardable

Defined in:

lib/gapic/schema/wrappers.rb

Overview

Wrapper for a protobuf enum.

Instance Attribute Summary

• #values ⇒ Object readonly

  @ return [EnumValue] the EnumValues contained in this file.

Attributes inherited from Proto

#address, #descriptor, #docs, #parent

Instance Method Summary

• #initialize(descriptor, address, docs, values) ⇒ Enum constructor

  Initializes a message object.

• #name ⇒ String

  The unqualified name of the Enum.

• #options ⇒ Array<Google::Protobuf::EnumOptions>

  The options of the enum.

Methods inherited from Proto

#containing_api, #containing_file, #docs_leading_comments, #leading_comments, #leading_detached_comments, #path, #span, #trailing_comments

Constructor Details

#initialize(descriptor, address, docs, values) ⇒ Enum

Initializes a message object.

Parameters:

• descriptor (Google::Protobuf::DescriptorProto) —

  the protobuf representation of this service.

• address (Enumerable<String>) —

  The address of the proto. See #address for more info.

• docs (Google::Protobuf::SourceCodeInfo::Location) —

  The docs of the proto. See #docs for more info.

• values (Enumerable<EnumValue>) —

  The EnumValues of this enum.

# File 'lib/gapic/schema/wrappers.rb', line 460

def initialize descriptor, address, docs, values
  super descriptor, address, docs
  @values = values || []
  @values.each { |v| v.parent = self }
end

Instance Attribute Details

#values ⇒ Object (readonly)

@ return [EnumValue] the EnumValues contained in this file.

# File 'lib/gapic/schema/wrappers.rb', line 448

class Enum < Proto
  extend Forwardable
  attr_reader :values

  # Initializes a message object.
  # @param descriptor [Google::Protobuf::DescriptorProto] the protobuf
  #   representation of this service.
  # @param address [Enumerable<String>] The address of the proto. See
  #   #address for more info.
  # @param docs [Google::Protobuf::SourceCodeInfo::Location] The docs
  #   of the proto. See #docs for more info.
  # @param values [Enumerable<EnumValue>] The EnumValues of this enum.
  def initialize descriptor, address, docs, values
    super descriptor, address, docs
    @values = values || []
    @values.each { |v| v.parent = self }
  end

  # @!method name
  #   @return [String] the unqualified name of the Enum.
  # @!method options
  #   @return [Array<Google::Protobuf::EnumOptions>] the options of the
  #     enum.
  def_delegators(
    :descriptor,
    :name,
    :options
  )
end

Instance Method Details

#name ⇒ String

Returns the unqualified name of the Enum.

Returns:

• (String) —

  the unqualified name of the Enum.

# File 'lib/gapic/schema/wrappers.rb', line 471

def_delegators(
  :descriptor,
  :name,
  :options
)

#options ⇒ Array<Google::Protobuf::EnumOptions>

Returns the options of the enum.

Returns:

• (Array<Google::Protobuf::EnumOptions>) —

  the options of the enum.

# File 'lib/gapic/schema/wrappers.rb', line 471

def_delegators(
  :descriptor,
  :name,
  :options
)