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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/serviceusage_v1/classes.rb,
generated/google/apis/serviceusage_v1/representations.rb,
generated/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.



1273
1274
1275
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 1273

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

Instance Attribute Details

#cardinality ⇒ String

The field cardinality. Corresponds to the JSON property cardinality

Returns:

  • (String) 


1223
1224
1225
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 1223

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) 


1228
1229
1230
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 1228

def default_value
  @default_value
end

#json_name ⇒ String

The field JSON name. Corresponds to the JSON property jsonName

Returns:

  • (String) 


1233
1234
1235
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 1233

def json_name
  @json_name
end

#kind ⇒ String

The field type. Corresponds to the JSON property kind

Returns:

  • (String) 


1238
1239
1240
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 1238

def kind
  @kind
end

#name ⇒ String

The field name. Corresponds to the JSON property name

Returns:

  • (String) 


1243
1244
1245
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 1243

def name
  @name
end

#number ⇒ Fixnum

The field number. Corresponds to the JSON property number

Returns:

  • (Fixnum) 


1248
1249
1250
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 1248

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) 


1254
1255
1256
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 1254

def oneof_index
  @oneof_index
end

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

The protocol buffer options. Corresponds to the JSON property options

Returns:



1259
1260
1261
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 1259

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) 


1264
1265
1266
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 1264

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) 


1271
1272
1273
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 1271

def type_url
  @type_url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 1278

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