Class: Google::Apis::ChromepolicyV1::Proto2FieldDescriptorProto

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

Overview

Describes a field within a message.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Proto2FieldDescriptorProto

Returns a new instance of Proto2FieldDescriptorProto.



879
880
881
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 879

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

Instance Attribute Details

#default_value ⇒ String

For numeric types, contains the original text representation of the value. For booleans, "true" or "false". For strings, contains the default text contents ( not escaped in any way). For bytes, contains the C escaped value. All bytes >= 128 are escaped. Corresponds to the JSON property defaultValue

Returns:

  • (String) 


814
815
816
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 814

def default_value
  @default_value
end

#json_name ⇒ String

JSON name of this field. The value is set by protocol compiler. If the user has set a "json_name" option on this field, that option's value will be used. Otherwise, it's deduced from the field's name by converting it to camelCase. Corresponds to the JSON property jsonName

Returns:

  • (String) 


821
822
823
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 821

def json_name
  @json_name
end

#label ⇒ String

Corresponds to the JSON property label

Returns:

  • (String) 


826
827
828
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 826

def label
  @label
end

#name ⇒ String

Corresponds to the JSON property name

Returns:

  • (String) 


831
832
833
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 831

def name
  @name
end

#number ⇒ Fixnum

Corresponds to the JSON property number

Returns:

  • (Fixnum) 


836
837
838
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 836

def number
  @number
end

#oneof_index ⇒ Fixnum

If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof. Corresponds to the JSON property oneofIndex

Returns:

  • (Fixnum) 


842
843
844
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 842

def oneof_index
  @oneof_index
end

#proto3_optional ⇒ Boolean Also known as: proto3_optional?

If true, this is a proto3 "optional". When a proto3 field is optional, it tracks presence regardless of field type. When proto3_optional is true, this field must be belong to a oneof to signal to old proto3 clients that presence is tracked for this field. This oneof is known as a "synthetic" oneof, and this field must be its sole member (each proto3 optional field gets its own synthetic oneof). Synthetic oneofs exist in the descriptor only, and do not generate any API. Synthetic oneofs must be ordered after all "real" oneofs. For message fields, proto3_optional doesn't create any semantic change, since non-repeated message fields always track presence. However it still indicates the semantic detail of whether the user wrote "optional" or not. This can be useful for round-tripping the .proto file. For consistency we give message fields a synthetic oneof also, even though it is not required to track presence. This is especially important because the parser can't tell if a field is a message or an enum, so it must always create a synthetic oneof. Proto2 optional fields do not set this flag, because they already indicate optional with LABEL_OPTIONAL. Corresponds to the JSON property proto3Optional

Returns:

  • (Boolean) 


862
863
864
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 862

def proto3_optional
  @proto3_optional
end

#type ⇒ String

If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP. Corresponds to the JSON property type

Returns:

  • (String) 


869
870
871
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 869

def type
  @type
end

#type_name ⇒ String

For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace). Corresponds to the JSON property typeName

Returns:

  • (String) 


877
878
879
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 877

def type_name
  @type_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



884
885
886
887
888
889
890
891
892
893
894
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 884

def update!(**args)
  @default_value = args[:default_value] if args.key?(:default_value)
  @json_name = args[:json_name] if args.key?(:json_name)
  @label = args[:label] if args.key?(:label)
  @name = args[:name] if args.key?(:name)
  @number = args[:number] if args.key?(:number)
  @oneof_index = args[:oneof_index] if args.key?(:oneof_index)
  @proto3_optional = args[:proto3_optional] if args.key?(:proto3_optional)
  @type = args[:type] if args.key?(:type)
  @type_name = args[:type_name] if args.key?(:type_name)
end