Class: Google::Apis::ServiceusageV1::Field

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/serviceusage_v1/classes.rb,
lib/google/apis/serviceusage_v1/representations.rb,
lib/google/apis/serviceusage_v1/representations.rb

Overview

A single field of a message type.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Field

Returns a new instance of Field.



1767
1768
1769
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 1767

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#cardinality ⇒ String

The field cardinality. Corresponds to the JSON property cardinality

Returns:

  • (String) 


1717
1718
1719
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 1717

def cardinality
  @cardinality
end

#default_value ⇒ String

The string value of the default value of this field. Proto2 syntax only. Corresponds to the JSON property defaultValue

Returns:

  • (String) 


1722
1723
1724
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 1722

def default_value
  @default_value
end

#json_name ⇒ String

The field JSON name. Corresponds to the JSON property jsonName

Returns:

  • (String) 


1727
1728
1729
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 1727

def json_name
  @json_name
end

#kind ⇒ String

The field type. Corresponds to the JSON property kind

Returns:

  • (String) 


1732
1733
1734
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 1732

def kind
  @kind
end

#name ⇒ String

The field name. Corresponds to the JSON property name

Returns:

  • (String) 


1737
1738
1739
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 1737

def name
  @name
end

#number ⇒ Fixnum

The field number. Corresponds to the JSON property number

Returns:

  • (Fixnum) 


1742
1743
1744
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 1742

def number
  @number
end

#oneof_index ⇒ Fixnum

The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list. Corresponds to the JSON property oneofIndex

Returns:

  • (Fixnum) 


1748
1749
1750
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 1748

def oneof_index
  @oneof_index
end

#options ⇒ Array<Google::Apis::ServiceusageV1::Option>

The protocol buffer options. Corresponds to the JSON property options

Returns:



1753
1754
1755
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 1753

def options
  @options
end

#packed ⇒ Boolean Also known as: packed?

Whether to use alternative packed wire representation. Corresponds to the JSON property packed

Returns:

  • (Boolean) 


1758
1759
1760
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 1758

def packed
  @packed
end

#type_url ⇒ String

The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp". Corresponds to the JSON property typeUrl

Returns:

  • (String) 


1765
1766
1767
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 1765

def type_url
  @type_url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 1772

def update!(**args)
  @cardinality = args[:cardinality] if args.key?(:cardinality)
  @default_value = args[:default_value] if args.key?(:default_value)
  @json_name = args[:json_name] if args.key?(:json_name)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @number = args[:number] if args.key?(:number)
  @oneof_index = args[:oneof_index] if args.key?(:oneof_index)
  @options = args[:options] if args.key?(:options)
  @packed = args[:packed] if args.key?(:packed)
  @type_url = args[:type_url] if args.key?(:type_url)
end