Class: Google::Apis::ServiceusageV1beta1::Field

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

Overview

A single field of a message type. New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Field

Returns a new instance of Field.



2201
2202
2203
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 2201

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

Instance Attribute Details

#cardinality ⇒ String

The field cardinality. Corresponds to the JSON property cardinality

Returns:

  • (String) 


2151
2152
2153
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 2151

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) 


2156
2157
2158
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 2156

def default_value
  @default_value
end

#json_name ⇒ String

The field JSON name. Corresponds to the JSON property jsonName

Returns:

  • (String) 


2161
2162
2163
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 2161

def json_name
  @json_name
end

#kind ⇒ String

The field type. Corresponds to the JSON property kind

Returns:

  • (String) 


2166
2167
2168
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 2166

def kind
  @kind
end

#name ⇒ String

The field name. Corresponds to the JSON property name

Returns:

  • (String) 


2171
2172
2173
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 2171

def name
  @name
end

#number ⇒ Fixnum

The field number. Corresponds to the JSON property number

Returns:

  • (Fixnum) 


2176
2177
2178
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 2176

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) 


2182
2183
2184
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 2182

def oneof_index
  @oneof_index
end

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

The protocol buffer options. Corresponds to the JSON property options

Returns:



2187
2188
2189
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 2187

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) 


2192
2193
2194
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 2192

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) 


2199
2200
2201
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 2199

def type_url
  @type_url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 2206

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