Class: Google::Apis::GamesV1::CreateRoomRequest

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

Overview

This is a JSON template for a room creation request.

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) ⇒ CreateRoomRequest

Returns a new instance of CreateRoomRequest.


3357
3358
3359
# File 'generated/google/apis/games_v1/classes.rb', line 3357

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

Instance Attribute Details

#auto_matching_criteriaGoogle::Apis::GamesV1::RoomAutoMatchingCriteria

This is a JSON template for a room auto-match criteria object. Corresponds to the JSON property autoMatchingCriteria


3316
3317
3318
# File 'generated/google/apis/games_v1/classes.rb', line 3316

def auto_matching_criteria
  @auto_matching_criteria
end

#capabilitiesArray<String>

The capabilities that this client supports for realtime communication. Corresponds to the JSON property capabilities

Returns:

  • (Array<String>)

3321
3322
3323
# File 'generated/google/apis/games_v1/classes.rb', line 3321

def capabilities
  @capabilities
end

#client_addressGoogle::Apis::GamesV1::RoomClientAddress

This is a JSON template for the client address when setting up a room. Corresponds to the JSON property clientAddress


3326
3327
3328
# File 'generated/google/apis/games_v1/classes.rb', line 3326

def client_address
  @client_address
end

#invited_player_idsArray<String>

The player IDs to invite to the room. Corresponds to the JSON property invitedPlayerIds

Returns:

  • (Array<String>)

3331
3332
3333
# File 'generated/google/apis/games_v1/classes.rb', line 3331

def invited_player_ids
  @invited_player_ids
end

#kindString

Uniquely identifies the type of this resource. Value is always the fixed string games#roomCreateRequest. Corresponds to the JSON property kind

Returns:

  • (String)

3337
3338
3339
# File 'generated/google/apis/games_v1/classes.rb', line 3337

def kind
  @kind
end

#network_diagnosticsGoogle::Apis::GamesV1::NetworkDiagnostics

This is a JSON template for network diagnostics reported for a client. Corresponds to the JSON property networkDiagnostics


3342
3343
3344
# File 'generated/google/apis/games_v1/classes.rb', line 3342

def network_diagnostics
  @network_diagnostics
end

#request_idString

A randomly generated numeric ID. This number is used at the server to ensure that the request is handled correctly across retries. Corresponds to the JSON property requestId

Returns:

  • (String)

3348
3349
3350
# File 'generated/google/apis/games_v1/classes.rb', line 3348

def request_id
  @request_id
end

#variantFixnum

The variant / mode of the application to be played. This can be any integer value, or left blank. You should use a small number of variants to keep the auto-matching pool as large as possible. Corresponds to the JSON property variant

Returns:

  • (Fixnum)

3355
3356
3357
# File 'generated/google/apis/games_v1/classes.rb', line 3355

def variant
  @variant
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
# File 'generated/google/apis/games_v1/classes.rb', line 3362

def update!(**args)
  @auto_matching_criteria = args[:auto_matching_criteria] if args.key?(:auto_matching_criteria)
  @capabilities = args[:capabilities] if args.key?(:capabilities)
  @client_address = args[:client_address] if args.key?(:client_address)
  @invited_player_ids = args[:invited_player_ids] if args.key?(:invited_player_ids)
  @kind = args[:kind] if args.key?(:kind)
  @network_diagnostics = args[:network_diagnostics] if args.key?(:network_diagnostics)
  @request_id = args[:request_id] if args.key?(:request_id)
  @variant = args[:variant] if args.key?(:variant)
end