Class: Google::Apis::MonitoringV3::Field

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

Overview

A single field of a message type.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Field

Returns a new instance of Field.


1016
1017
1018
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1016

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

Instance Attribute Details

#cardinalityString

The field cardinality. Corresponds to the JSON property cardinality

Returns:

  • (String)

987
988
989
# File 'generated/google/apis/monitoring_v3/classes.rb', line 987

def cardinality
  @cardinality
end

#default_valueString

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

Returns:

  • (String)

966
967
968
# File 'generated/google/apis/monitoring_v3/classes.rb', line 966

def default_value
  @default_value
end

#json_nameString

The field JSON name. Corresponds to the JSON property jsonName

Returns:

  • (String)

971
972
973
# File 'generated/google/apis/monitoring_v3/classes.rb', line 971

def json_name
  @json_name
end

#kindString

The field type. Corresponds to the JSON property kind

Returns:

  • (String)

1014
1015
1016
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1014

def kind
  @kind
end

#nameString

The field name. Corresponds to the JSON property name

Returns:

  • (String)

998
999
1000
# File 'generated/google/apis/monitoring_v3/classes.rb', line 998

def name
  @name
end

#numberFixnum

The field number. Corresponds to the JSON property number

Returns:

  • (Fixnum)

1009
1010
1011
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1009

def number
  @number
end

#oneof_indexFixnum

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)

982
983
984
# File 'generated/google/apis/monitoring_v3/classes.rb', line 982

def oneof_index
  @oneof_index
end

#optionsArray<Google::Apis::MonitoringV3::Option>

The protocol buffer options. Corresponds to the JSON property options


976
977
978
# File 'generated/google/apis/monitoring_v3/classes.rb', line 976

def options
  @options
end

#packedBoolean Also known as: packed?

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

Returns:

  • (Boolean)

1003
1004
1005
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1003

def packed
  @packed
end

#type_urlString

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)

993
994
995
# File 'generated/google/apis/monitoring_v3/classes.rb', line 993

def type_url
  @type_url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1021

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