Class: Google::Apis::GameservicesV1beta::CounterOptions

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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ CounterOptions

Returns a new instance of CounterOptions.



373
374
375
# File 'generated/google/apis/gameservices_v1beta/classes.rb', line 373

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

Instance Attribute Details

#custom_fieldsArray<Google::Apis::GameservicesV1beta::CustomField>

Custom fields. Corresponds to the JSON property customFields



361
362
363
# File 'generated/google/apis/gameservices_v1beta/classes.rb', line 361

def custom_fields
  @custom_fields
end

#fieldString

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

Returns:

  • (String)


366
367
368
# File 'generated/google/apis/gameservices_v1beta/classes.rb', line 366

def field
  @field
end

#metricString

The metric to update. Corresponds to the JSON property metric

Returns:

  • (String)


371
372
373
# File 'generated/google/apis/gameservices_v1beta/classes.rb', line 371

def metric
  @metric
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



378
379
380
381
382
# File 'generated/google/apis/gameservices_v1beta/classes.rb', line 378

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