Class: Google::Apis::GameservicesV1::CounterOptions

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

Overview

Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count" . Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. Supported field names:

  • "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. Examples: counter metric: "/debug_access_count" field: "iam_principal" ==> increment counter / iam/policy/debug_access_count iam_principal=[value of IAMContext.principal]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CounterOptions

Returns a new instance of CounterOptions.



317
318
319
 
# File 'generated/google/apis/gameservices_v1/classes.rb', line 317

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

Instance Attribute Details

#custom_fields ⇒ Array<Google::Apis::GameservicesV1::CustomField>

Custom fields. Corresponds to the JSON property customFields

Returns:



305
306
307
 
# File 'generated/google/apis/gameservices_v1/classes.rb', line 305

def custom_fields
  @custom_fields
end

#field ⇒ String

The field value to attribute. Corresponds to the JSON property field

Returns:

  • (String) 


310
311
312
 
# File 'generated/google/apis/gameservices_v1/classes.rb', line 310

def field
  @field
end

#metric ⇒ String

The metric to update. Corresponds to the JSON property metric

Returns:

  • (String) 


315
316
317
 
# File 'generated/google/apis/gameservices_v1/classes.rb', line 315

def metric
  @metric
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



322
323
324
325
326
 
# File 'generated/google/apis/gameservices_v1/classes.rb', line 322

def update!(**args)
  @custom_fields = args[:custom_fields] if args.key?(:custom_fields)
  @field = args[:field] if args.key?(:field)
  @metric = args[:metric] if args.key?(:metric)
end