Class: Google::Apis::GameservicesV1::GameServicesService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
generated/google/apis/gameservices_v1/service.rb

Overview

Game Services API

Deploy and manage infrastructure for global multiplayer gaming experiences.

Examples:

require 'google/apis/gameservices_v1'

Gameservices = Google::Apis::GameservicesV1 # Alias the module
service = Gameservices::GameServicesService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ GameServicesService

Returns a new instance of GameServicesService.



45
46
47
48
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 45

def initialize
  super('https://gameservices.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



38
39
40
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 38

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



43
44
45
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::Empty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String) —

    The name of the operation resource to be cancelled.

  • cancel_operation_request_object (Google::Apis::GameservicesV1::CancelOperationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



767
768
769
770
771
772
773
774
775
776
777
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 767

def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.request_representation = Google::Apis::GameservicesV1::CancelOperationRequest::Representation
  command.request_object = cancel_operation_request_object
  command.response_representation = Google::Apis::GameservicesV1::Empty::Representation
  command.response_class = Google::Apis::GameservicesV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_game_server_deployment(parent, game_server_deployment_object = nil, deployment_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::Operation

Creates a new game server deployment in a given project and location.

Parameters:

  • parent (String) —

    Required. The parent resource name, in the following form: projects/project/ locations/location``.

  • game_server_deployment_object (Google::Apis::GameservicesV1::GameServerDeployment) (defaults to: nil)
  • deployment_id (String) (defaults to: nil) —

    Required. The ID of the game server delpoyment resource to be created.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 146

def create_project_location_game_server_deployment(parent, game_server_deployment_object = nil, deployment_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/gameServerDeployments', options)
  command.request_representation = Google::Apis::GameservicesV1::GameServerDeployment::Representation
  command.request_object = game_server_deployment_object
  command.response_representation = Google::Apis::GameservicesV1::Operation::Representation
  command.response_class = Google::Apis::GameservicesV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['deploymentId'] = deployment_id unless deployment_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_game_server_deployment_config(parent, game_server_config_object = nil, config_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::Operation

Creates a new game server config in a given project, location, and game server deployment. Game server configs are immutable, and are not applied until referenced in the game server deployment rollout resource.

Parameters:

  • parent (String) —

    Required. The parent resource name, in the following form: projects/project/ locations/location/gameServerDeployments/deployment/.

  • game_server_config_object (Google::Apis::GameservicesV1::GameServerConfig) (defaults to: nil)
  • config_id (String) (defaults to: nil) —

    Required. The ID of the game server config resource to be created.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



612
613
614
615
616
617
618
619
620
621
622
623
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 612

def create_project_location_game_server_deployment_config(parent, game_server_config_object = nil, config_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/configs', options)
  command.request_representation = Google::Apis::GameservicesV1::GameServerConfig::Representation
  command.request_object = game_server_config_object
  command.response_representation = Google::Apis::GameservicesV1::Operation::Representation
  command.response_class = Google::Apis::GameservicesV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['configId'] = config_id unless config_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_realm(parent, realm_object = nil, realm_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::Operation

Creates a new realm in a given project and location.

Parameters:

  • parent (String) —

    Required. The parent resource name, in the following form: projects/project/ locations/location``.

  • realm_object (Google::Apis::GameservicesV1::Realm) (defaults to: nil)
  • realm_id (String) (defaults to: nil) —

    Required. The ID of the realm resource to be created.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



913
914
915
916
917
918
919
920
921
922
923
924
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 913

def create_project_location_realm(parent, realm_object = nil, realm_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/realms', options)
  command.request_representation = Google::Apis::GameservicesV1::Realm::Representation
  command.request_object = realm_object
  command.response_representation = Google::Apis::GameservicesV1::Operation::Representation
  command.response_class = Google::Apis::GameservicesV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['realmId'] = realm_id unless realm_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_realm_game_server_cluster(parent, game_server_cluster_object = nil, game_server_cluster_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::Operation

Creates a new game server cluster in a given project and location.

Parameters:

  • parent (String) —

    Required. The parent resource name, in the following form: projects/project/ locations/location/realms/realm-id``.

  • game_server_cluster_object (Google::Apis::GameservicesV1::GameServerCluster) (defaults to: nil)
  • game_server_cluster_id (String) (defaults to: nil) —

    Required. The ID of the game server cluster resource to be created.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 1143

def create_project_location_realm_game_server_cluster(parent, game_server_cluster_object = nil, game_server_cluster_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/gameServerClusters', options)
  command.request_representation = Google::Apis::GameservicesV1::GameServerCluster::Representation
  command.request_object = game_server_cluster_object
  command.response_representation = Google::Apis::GameservicesV1::Operation::Representation
  command.response_class = Google::Apis::GameservicesV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['gameServerClusterId'] = game_server_cluster_id unless game_server_cluster_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_game_server_deployment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::Operation

Deletes a single game server deployment.

Parameters:

  • name (String) —

    Required. The name of the game server delpoyment to delete, in the following form: projects/project/locations/location/gameServerDeployments/ deployment``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



181
182
183
184
185
186
187
188
189
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 181

def delete_project_location_game_server_deployment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GameservicesV1::Operation::Representation
  command.response_class = Google::Apis::GameservicesV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_game_server_deployment_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::Operation

Deletes a single game server config. The deletion will fail if the game server config is referenced in a game server deployment rollout.

Parameters:

  • name (String) —

    Required. The name of the game server config to delete, in the following form: projects/project/locations/location/gameServerDeployments/deployment/ configs/config``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



648
649
650
651
652
653
654
655
656
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 648

def delete_project_location_game_server_deployment_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GameservicesV1::Operation::Representation
  command.response_class = Google::Apis::GameservicesV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::Empty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



802
803
804
805
806
807
808
809
810
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 802

def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GameservicesV1::Empty::Representation
  command.response_class = Google::Apis::GameservicesV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_realm(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::Operation

Deletes a single realm.

Parameters:

  • name (String) —

    Required. The name of the realm to delete, in the following form: projects/ project/locations/location/realms/realm``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



947
948
949
950
951
952
953
954
955
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 947

def delete_project_location_realm(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GameservicesV1::Operation::Representation
  command.response_class = Google::Apis::GameservicesV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_realm_game_server_cluster(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::Operation

Deletes a single game server cluster.

Parameters:

  • name (String) —

    Required. The name of the game server cluster to delete, in the following form: projects/project/locations/location/gameServerClusters/cluster``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1177
1178
1179
1180
1181
1182
1183
1184
1185
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 1177

def delete_project_location_realm_game_server_cluster(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GameservicesV1::Operation::Representation
  command.response_class = Google::Apis::GameservicesV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#fetch_game_server_deployment_deployment_state(name, fetch_deployment_state_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::FetchDeploymentStateResponse

Retrieves information about the current state of the game server deployment. Gathers all the Agones fleets and Agones autoscalers, including fleets running an older version of the game server deployment.

Parameters:

  • name (String) —

    Required. The name of the game server delpoyment, in the following form: projects/project/locations/location/gameServerDeployments/deployment``.

  • fetch_deployment_state_request_object (Google::Apis::GameservicesV1::FetchDeploymentStateRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



215
216
217
218
219
220
221
222
223
224
225
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 215

def fetch_game_server_deployment_deployment_state(name, fetch_deployment_state_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:fetchDeploymentState', options)
  command.request_representation = Google::Apis::GameservicesV1::FetchDeploymentStateRequest::Representation
  command.request_object = fetch_deployment_state_request_object
  command.response_representation = Google::Apis::GameservicesV1::FetchDeploymentStateResponse::Representation
  command.response_class = Google::Apis::GameservicesV1::FetchDeploymentStateResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::Location

Gets information about a location.

Parameters:

  • name (String) —

    Resource name for the location.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



70
71
72
73
74
75
76
77
78
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 70

def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GameservicesV1::Location::Representation
  command.response_class = Google::Apis::GameservicesV1::Location
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_game_server_deployment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::GameServerDeployment

Gets details of a single game server deployment.

Parameters:

  • name (String) —

    Required. The name of the game server delpoyment to retrieve, in the following form: projects/project/locations/location/gameServerDeployments/ deployment``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



249
250
251
252
253
254
255
256
257
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 249

def get_project_location_game_server_deployment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GameservicesV1::GameServerDeployment::Representation
  command.response_class = Google::Apis::GameservicesV1::GameServerDeployment
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_game_server_deployment_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::GameServerConfig

Gets details of a single game server config.

Parameters:

  • name (String) —

    Required. The name of the game server config to retrieve, in the following form: projects/project/locations/location/gameServerDeployments/ deployment/configs/config``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



680
681
682
683
684
685
686
687
688
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 680

def get_project_location_game_server_deployment_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GameservicesV1::GameServerConfig::Representation
  command.response_class = Google::Apis::GameservicesV1::GameServerConfig
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_game_server_deployment_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

  • options_requested_policy_version (Fixnum) (defaults to: nil) —

    Optional. The policy format version to be returned. Valid values are 0, 1, and

    1. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation.
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



289
290
291
292
293
294
295
296
297
298
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 289

def get_project_location_game_server_deployment_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::GameservicesV1::Policy::Representation
  command.response_class = Google::Apis::GameservicesV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_game_server_deployment_rollout(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::GameServerDeploymentRollout

Gets details a single game server deployment rollout.

Parameters:

  • name (String) —

    Required. The name of the game server delpoyment to retrieve, in the following form: projects/project/locations/location/gameServerDeployments/ deployment/rollout.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



322
323
324
325
326
327
328
329
330
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 322

def get_project_location_game_server_deployment_rollout(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/rollout', options)
  command.response_representation = Google::Apis::GameservicesV1::GameServerDeploymentRollout::Representation
  command.response_class = Google::Apis::GameservicesV1::GameServerDeploymentRollout
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::Operation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



833
834
835
836
837
838
839
840
841
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 833

def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GameservicesV1::Operation::Representation
  command.response_class = Google::Apis::GameservicesV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_realm(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::Realm

Gets details of a single realm.

Parameters:

  • name (String) —

    Required. The name of the realm to retrieve, in the following form: projects/ project/locations/location/realms/realm``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



978
979
980
981
982
983
984
985
986
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 978

def get_project_location_realm(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GameservicesV1::Realm::Representation
  command.response_class = Google::Apis::GameservicesV1::Realm
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_realm_game_server_cluster(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::GameServerCluster

Gets details of a single game server cluster.

Parameters:

  • name (String) —

    Required. The name of the game server cluster to retrieve, in the following form: projects/project/locations/location/realms/realm-id/ gameServerClusters/cluster``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1209
1210
1211
1212
1213
1214
1215
1216
1217
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 1209

def get_project_location_realm_game_server_cluster(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GameservicesV1::GameServerCluster::Representation
  command.response_class = Google::Apis::GameservicesV1::GameServerCluster
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_game_server_deployment_configs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::ListGameServerConfigsResponse

Lists game server configs in a given project, location, and game server deployment.

Parameters:

  • parent (String) —

    Required. The parent resource name, in the following form: projects/project/ locations/location/gameServerDeployments/deployment/configs/*.

  • filter (String) (defaults to: nil) —

    Optional. The filter to apply to list results.

  • order_by (String) (defaults to: nil) —

    Optional. Specifies the ordering of results following syntax at https://cloud. google.com/apis/design/design_patterns#sorting_order.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more GameServerConfigs left to be queried.

  • page_token (String) (defaults to: nil) —

    Optional. The next_page_token value returned from a previous list request, if any.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



725
726
727
728
729
730
731
732
733
734
735
736
737
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 725

def list_project_location_game_server_deployment_configs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/configs', options)
  command.response_representation = Google::Apis::GameservicesV1::ListGameServerConfigsResponse::Representation
  command.response_class = Google::Apis::GameservicesV1::ListGameServerConfigsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_game_server_deployments(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::ListGameServerDeploymentsResponse

Lists game server deployments in a given project and location.

Parameters:

  • parent (String) —

    Required. The parent resource name, in the following form: projects/project/ locations/location``.

  • filter (String) (defaults to: nil) —

    Optional. The filter to apply to list results.

  • order_by (String) (defaults to: nil) —

    Optional. Specifies the ordering of results following syntax at https://cloud. google.com/apis/design/design_patterns#sorting_order.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. The maximum number of items to return. If unspecified, the server will pick an appropriate default. The server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more GameServerDeployments left to be queried.

  • page_token (String) (defaults to: nil) —

    Optional. The next_page_token value returned from a previous List request, if any.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 366

def list_project_location_game_server_deployments(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/gameServerDeployments', options)
  command.response_representation = Google::Apis::GameservicesV1::ListGameServerDeploymentsResponse::Representation
  command.response_class = Google::Apis::GameservicesV1::ListGameServerDeploymentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::ListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/name=users/*/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



876
877
878
879
880
881
882
883
884
885
886
887
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 876

def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::GameservicesV1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::GameservicesV1::ListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_realm_game_server_clusters(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::ListGameServerClustersResponse

Lists game server clusters in a given project and location.

Parameters:

  • parent (String) —

    Required. The parent resource name, in the following form: "projects/project/ locations/location/realms/realm".

  • filter (String) (defaults to: nil) —

    Optional. The filter to apply to list results.

  • order_by (String) (defaults to: nil) —

    Optional. Specifies the ordering of results following syntax at https://cloud. google.com/apis/design/design_patterns#sorting_order.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. The maximum number of items to return. If unspecified, the server will pick an appropriate default. The server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more GameServerClusters left to be queried.

  • page_token (String) (defaults to: nil) —

    Optional. The next_page_token value returned from a previous List request, if any.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 1253

def list_project_location_realm_game_server_clusters(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/gameServerClusters', options)
  command.response_representation = Google::Apis::GameservicesV1::ListGameServerClustersResponse::Representation
  command.response_class = Google::Apis::GameservicesV1::ListGameServerClustersResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_realms(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::ListRealmsResponse

Lists realms in a given project and location.

Parameters:

  • parent (String) —

    Required. The parent resource name, in the following form: projects/project/ locations/location``.

  • filter (String) (defaults to: nil) —

    Optional. The filter to apply to list results.

  • order_by (String) (defaults to: nil) —

    Optional. Specifies the ordering of results following syntax at https://cloud. google.com/apis/design/design_patterns#sorting_order.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more realms left to be queried.

  • page_token (String) (defaults to: nil) —

    Optional. The next_page_token value returned from a previous List request, if any.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 1022

def list_project_location_realms(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/realms', options)
  command.response_representation = Google::Apis::GameservicesV1::ListRealmsResponse::Representation
  command.response_class = Google::Apis::GameservicesV1::ListRealmsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_locations(name, filter: nil, include_unrevealed_locations: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::ListLocationsResponse

Lists information about the supported locations for this service.

Parameters:

  • name (String) —

    The resource that owns the locations collection, if applicable.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • include_unrevealed_locations (Boolean) (defaults to: nil) —

    If true, the returned list will include locations which are not yet revealed.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 108

def list_project_locations(name, filter: nil, include_unrevealed_locations: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/locations', options)
  command.response_representation = Google::Apis::GameservicesV1::ListLocationsResponse::Representation
  command.response_class = Google::Apis::GameservicesV1::ListLocationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['includeUnrevealedLocations'] = include_unrevealed_locations unless include_unrevealed_locations.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_game_server_deployment(name, game_server_deployment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::Operation

Patches a game server deployment.

Parameters:

  • name (String) —

    The resource name of the game server deployment, in the following form: projects/project/locations/location/gameServerDeployments/deployment`. For example,projects/my-project/locations/global/gameServerDeployments/my- deployment`.

  • game_server_deployment_object (Google::Apis::GameservicesV1::GameServerDeployment) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. Mask of fields to update. At least one path must be supplied in this field. For the FieldMask definition, see https://developers.google.com/ protocol-buffers/docs/reference/google.protobuf#fieldmask

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 408

def patch_project_location_game_server_deployment(name, game_server_deployment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::GameservicesV1::GameServerDeployment::Representation
  command.request_object = game_server_deployment_object
  command.response_representation = Google::Apis::GameservicesV1::Operation::Representation
  command.response_class = Google::Apis::GameservicesV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_realm(name, realm_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::Operation

Patches a single realm.

Parameters:

  • name (String) —

    The resource name of the realm, in the following form: projects/project/ locations/location/realms/realm`. For example,projects/my-project/ locations/location/realms/my-realm`.

  • realm_object (Google::Apis::GameservicesV1::Realm) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/ google.protobuf#fieldmask

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 1063

def patch_project_location_realm(name, realm_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::GameservicesV1::Realm::Representation
  command.request_object = realm_object
  command.response_representation = Google::Apis::GameservicesV1::Operation::Representation
  command.response_class = Google::Apis::GameservicesV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_realm_game_server_cluster(name, game_server_cluster_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::Operation

Patches a single game server cluster.

Parameters:

  • name (String) —

    Required. The resource name of the game server cluster, in the following form: projects/project/locations/location/realms/realm/gameServerClusters/ cluster`. For example,projects/my-project/locations/location/realms/ zanzibar/gameServerClusters/my-onprem-cluster`.

  • game_server_cluster_object (Google::Apis::GameservicesV1::GameServerCluster) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. Mask of fields to update. At least one path must be supplied in this field. For the FieldMask definition, see https://developers.google.com/ protocol-buffers/docs/reference/google.protobuf#fieldmask

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 1295

def patch_project_location_realm_game_server_cluster(name, game_server_cluster_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::GameservicesV1::GameServerCluster::Representation
  command.request_object = game_server_cluster_object
  command.response_representation = Google::Apis::GameservicesV1::Operation::Representation
  command.response_class = Google::Apis::GameservicesV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#preview_project_location_game_server_deployment_rollout(name, game_server_deployment_rollout_object = nil, preview_time: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::PreviewGameServerDeploymentRolloutResponse

Previews the game server deployment rollout. This API does not mutate the rollout resource.

Parameters:

  • name (String) —

    The resource name of the game server deployment rollout, in the following form: projects/project/locations/location/gameServerDeployments/deployment/ rollout. For example, projects/my-project/locations/global/ gameServerDeployments/my-deployment/rollout.

  • game_server_deployment_rollout_object (Google::Apis::GameservicesV1::GameServerDeploymentRollout) (defaults to: nil)
  • preview_time (String) (defaults to: nil) —

    Optional. The target timestamp to compute the preview. Defaults to the immediately after the proposed rollout completes.

  • update_mask (String) (defaults to: nil) —

    Optional. Mask of fields to update. At least one path must be supplied in this field. For the FieldMask definition, see https://developers.google.com/ protocol-buffers/docs/reference/google.protobuf#fieldmask

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 453

def preview_project_location_game_server_deployment_rollout(name, game_server_deployment_rollout_object = nil, preview_time: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}/rollout:preview', options)
  command.request_representation = Google::Apis::GameservicesV1::GameServerDeploymentRollout::Representation
  command.request_object = game_server_deployment_rollout_object
  command.response_representation = Google::Apis::GameservicesV1::PreviewGameServerDeploymentRolloutResponse::Representation
  command.response_class = Google::Apis::GameservicesV1::PreviewGameServerDeploymentRolloutResponse
  command.params['name'] = name unless name.nil?
  command.query['previewTime'] = preview_time unless preview_time.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#preview_project_location_realm_game_server_cluster_create(parent, game_server_cluster_object = nil, game_server_cluster_id: nil, preview_time: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::PreviewCreateGameServerClusterResponse

Previews creation of a new game server cluster in a given project and location.

Parameters:

  • parent (String) —

    Required. The parent resource name, in the following form: projects/project/ locations/location/realms/realm``.

  • game_server_cluster_object (Google::Apis::GameservicesV1::GameServerCluster) (defaults to: nil)
  • game_server_cluster_id (String) (defaults to: nil) —

    Required. The ID of the game server cluster resource to be created.

  • preview_time (String) (defaults to: nil) —

    Optional. The target timestamp to compute the preview.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 1334

def preview_project_location_realm_game_server_cluster_create(parent, game_server_cluster_object = nil, game_server_cluster_id: nil, preview_time: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/gameServerClusters:previewCreate', options)
  command.request_representation = Google::Apis::GameservicesV1::GameServerCluster::Representation
  command.request_object = game_server_cluster_object
  command.response_representation = Google::Apis::GameservicesV1::PreviewCreateGameServerClusterResponse::Representation
  command.response_class = Google::Apis::GameservicesV1::PreviewCreateGameServerClusterResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['gameServerClusterId'] = game_server_cluster_id unless game_server_cluster_id.nil?
  command.query['previewTime'] = preview_time unless preview_time.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#preview_project_location_realm_game_server_cluster_delete(name, preview_time: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::PreviewDeleteGameServerClusterResponse

Previews deletion of a single game server cluster.

Parameters:

  • name (String) —

    Required. The name of the game server cluster to delete, in the following form: projects/project/locations/location/gameServerClusters/cluster``.

  • preview_time (String) (defaults to: nil) —

    Optional. The target timestamp to compute the preview.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 1371

def preview_project_location_realm_game_server_cluster_delete(name, preview_time: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}:previewDelete', options)
  command.response_representation = Google::Apis::GameservicesV1::PreviewDeleteGameServerClusterResponse::Representation
  command.response_class = Google::Apis::GameservicesV1::PreviewDeleteGameServerClusterResponse
  command.params['name'] = name unless name.nil?
  command.query['previewTime'] = preview_time unless preview_time.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#preview_project_location_realm_game_server_cluster_update(name, game_server_cluster_object = nil, preview_time: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::PreviewUpdateGameServerClusterResponse

Previews updating a GameServerCluster.

Parameters:

  • name (String) —

    Required. The resource name of the game server cluster, in the following form: projects/project/locations/location/realms/realm/gameServerClusters/ cluster`. For example,projects/my-project/locations/location/realms/ zanzibar/gameServerClusters/my-onprem-cluster`.

  • game_server_cluster_object (Google::Apis::GameservicesV1::GameServerCluster) (defaults to: nil)
  • preview_time (String) (defaults to: nil) —

    Optional. The target timestamp to compute the preview.

  • update_mask (String) (defaults to: nil) —

    Required. Mask of fields to update. At least one path must be supplied in this field. For the FieldMask definition, see https://developers.google.com/ protocol-buffers/docs/reference/google.protobuf#fieldmask

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 1412

def preview_project_location_realm_game_server_cluster_update(name, game_server_cluster_object = nil, preview_time: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}:previewUpdate', options)
  command.request_representation = Google::Apis::GameservicesV1::GameServerCluster::Representation
  command.request_object = game_server_cluster_object
  command.response_representation = Google::Apis::GameservicesV1::PreviewUpdateGameServerClusterResponse::Representation
  command.response_class = Google::Apis::GameservicesV1::PreviewUpdateGameServerClusterResponse
  command.params['name'] = name unless name.nil?
  command.query['previewTime'] = preview_time unless preview_time.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#preview_project_location_realm_update(name, realm_object = nil, preview_time: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::PreviewRealmUpdateResponse

Previews patches to a single realm.

Parameters:

  • name (String) —

    The resource name of the realm, in the following form: projects/project/ locations/location/realms/realm`. For example,projects/my-project/ locations/location/realms/my-realm`.

  • realm_object (Google::Apis::GameservicesV1::Realm) (defaults to: nil)
  • preview_time (String) (defaults to: nil) —

    Optional. The target timestamp to compute the preview.

  • update_mask (String) (defaults to: nil) —

    Required. The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/ google.protobuf#fieldmask

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 1105

def preview_project_location_realm_update(name, realm_object = nil, preview_time: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}:previewUpdate', options)
  command.request_representation = Google::Apis::GameservicesV1::Realm::Representation
  command.request_object = realm_object
  command.response_representation = Google::Apis::GameservicesV1::PreviewRealmUpdateResponse::Representation
  command.response_class = Google::Apis::GameservicesV1::PreviewRealmUpdateResponse
  command.params['name'] = name unless name.nil?
  command.query['previewTime'] = preview_time unless preview_time.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_game_server_deployment_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::GameservicesV1::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



491
492
493
494
495
496
497
498
499
500
501
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 491

def set_game_server_deployment_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::GameservicesV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::GameservicesV1::Policy::Representation
  command.response_class = Google::Apis::GameservicesV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_game_server_deployment_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::GameservicesV1::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



529
530
531
532
533
534
535
536
537
538
539
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 529

def test_game_server_deployment_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::GameservicesV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::GameservicesV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::GameservicesV1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_project_location_game_server_deployment_rollout(name, game_server_deployment_rollout_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GameservicesV1::Operation

Patches a single game server deployment rollout. The method will not return an error if the update does not affect any existing realms. For example - if the default_game_server_config is changed but all existing realms use the override, that is valid. Similarly, if a non existing realm is explicitly called out in game_server_config_overrides field, that will also not result in an error.

Parameters:

  • name (String) —

    The resource name of the game server deployment rollout, in the following form: projects/project/locations/location/gameServerDeployments/deployment/ rollout. For example, projects/my-project/locations/global/ gameServerDeployments/my-deployment/rollout.

  • game_server_deployment_rollout_object (Google::Apis::GameservicesV1::GameServerDeploymentRollout) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. Mask of fields to update. At least one path must be supplied in this field. For the FieldMask definition, see https://developers.google.com/ protocol-buffers/docs/reference/google.protobuf#fieldmask

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



573
574
575
576
577
578
579
580
581
582
583
584
 
# File 'generated/google/apis/gameservices_v1/service.rb', line 573

def update_project_location_game_server_deployment_rollout(name, game_server_deployment_rollout_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}/rollout', options)
  command.request_representation = Google::Apis::GameservicesV1::GameServerDeploymentRollout::Representation
  command.request_object = game_server_deployment_rollout_object
  command.response_representation = Google::Apis::GameservicesV1::Operation::Representation
  command.response_class = Google::Apis::GameservicesV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end