Class v1beta.GameServerConfigsServiceClient

The game server config configures the game servers in an Agones fleet. v1beta

Package

@google-cloud/game-servers

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of GameServerConfigsServiceClient.

Parameter
NameDescription
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

gameServerConfigsServiceStub

gameServerConfigsServiceStub?: Promise<{
        [name: string]: Function;
    }>;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static get servicePath(): string;

The DNS address for this API service.

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

checkCreateGameServerConfigProgress(name)

checkCreateGameServerConfigProgress(name: string): Promise<LROperation<protos.google.cloud.gaming.v1beta.GameServerConfig, protos.google.cloud.gaming.v1beta.OperationMetadata>>;

Check the status of the long running operation returned by createGameServerConfig().

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.gaming.v1beta.GameServerConfig, protos.google.cloud.gaming.v1beta.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent resource name. Uses the form:
   *  `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The ID of the game server config resource to be created.
   */
  // const configId = 'abc123'
  /**
   *  Required. The game server config resource to be created.
   */
  // const gameServerConfig = {}

  // Imports the Gaming library
  const {GameServerConfigsServiceClient} =
    require('@google-cloud/game-servers').v1beta;

  // Instantiates a client
  const gamingClient = new GameServerConfigsServiceClient();

  async function callCreateGameServerConfig() {
    // Construct request
    const request = {
      parent,
      configId,
      gameServerConfig,
    };

    // Run request
    const [operation] = await gamingClient.createGameServerConfig(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateGameServerConfig();

checkDeleteGameServerConfigProgress(name)

checkDeleteGameServerConfigProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.gaming.v1beta.OperationMetadata>>;

Check the status of the long running operation returned by deleteGameServerConfig().

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.gaming.v1beta.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the game server config to delete. Uses the form:
   *  `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`.
   */
  // const name = 'abc123'

  // Imports the Gaming library
  const {GameServerConfigsServiceClient} =
    require('@google-cloud/game-servers').v1beta;

  // Instantiates a client
  const gamingClient = new GameServerConfigsServiceClient();

  async function callDeleteGameServerConfig() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await gamingClient.deleteGameServerConfig(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteGameServerConfig();

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
TypeDescription
Promise<void>

{Promise} A promise that resolves when the client is closed.

createGameServerConfig(request, options)

createGameServerConfig(request?: protos.google.cloud.gaming.v1beta.ICreateGameServerConfigRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.gaming.v1beta.IGameServerConfig, protos.google.cloud.gaming.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

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
NameDescription
request protos.google.cloud.gaming.v1beta.ICreateGameServerConfigRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.cloud.gaming.v1beta.IGameServerConfig, protos.google.cloud.gaming.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent resource name. Uses the form:
   *  `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The ID of the game server config resource to be created.
   */
  // const configId = 'abc123'
  /**
   *  Required. The game server config resource to be created.
   */
  // const gameServerConfig = {}

  // Imports the Gaming library
  const {GameServerConfigsServiceClient} =
    require('@google-cloud/game-servers').v1beta;

  // Instantiates a client
  const gamingClient = new GameServerConfigsServiceClient();

  async function callCreateGameServerConfig() {
    // Construct request
    const request = {
      parent,
      configId,
      gameServerConfig,
    };

    // Run request
    const [operation] = await gamingClient.createGameServerConfig(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateGameServerConfig();

createGameServerConfig(request, options, callback)

createGameServerConfig(request: protos.google.cloud.gaming.v1beta.ICreateGameServerConfigRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gaming.v1beta.IGameServerConfig, protos.google.cloud.gaming.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.gaming.v1beta.ICreateGameServerConfigRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.gaming.v1beta.IGameServerConfig, protos.google.cloud.gaming.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createGameServerConfig(request, callback)

createGameServerConfig(request: protos.google.cloud.gaming.v1beta.ICreateGameServerConfigRequest, callback: Callback<LROperation<protos.google.cloud.gaming.v1beta.IGameServerConfig, protos.google.cloud.gaming.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.gaming.v1beta.ICreateGameServerConfigRequest
callback Callback<LROperation<protos.google.cloud.gaming.v1beta.IGameServerConfig, protos.google.cloud.gaming.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteGameServerConfig(request, options)

deleteGameServerConfig(request?: protos.google.cloud.gaming.v1beta.IDeleteGameServerConfigRequest, options?: CallOptions): Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gaming.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

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

Parameters
NameDescription
request protos.google.cloud.gaming.v1beta.IDeleteGameServerConfigRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gaming.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the game server config to delete. Uses the form:
   *  `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`.
   */
  // const name = 'abc123'

  // Imports the Gaming library
  const {GameServerConfigsServiceClient} =
    require('@google-cloud/game-servers').v1beta;

  // Instantiates a client
  const gamingClient = new GameServerConfigsServiceClient();

  async function callDeleteGameServerConfig() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await gamingClient.deleteGameServerConfig(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteGameServerConfig();

deleteGameServerConfig(request, options, callback)

deleteGameServerConfig(request: protos.google.cloud.gaming.v1beta.IDeleteGameServerConfigRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gaming.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.gaming.v1beta.IDeleteGameServerConfigRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gaming.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteGameServerConfig(request, callback)

deleteGameServerConfig(request: protos.google.cloud.gaming.v1beta.IDeleteGameServerConfigRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gaming.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.gaming.v1beta.IDeleteGameServerConfigRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gaming.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

gameServerClusterPath(project, location, realm, cluster)

gameServerClusterPath(project: string, location: string, realm: string, cluster: string): string;

Return a fully-qualified gameServerCluster resource name string.

Parameters
NameDescription
project string
location string
realm string
cluster string
Returns
TypeDescription
string

{string} Resource name string.

gameServerConfigPath(project, location, deployment, config)

gameServerConfigPath(project: string, location: string, deployment: string, config: string): string;

Return a fully-qualified gameServerConfig resource name string.

Parameters
NameDescription
project string
location string
deployment string
config string
Returns
TypeDescription
string

{string} Resource name string.

gameServerDeploymentPath(project, location, deployment)

gameServerDeploymentPath(project: string, location: string, deployment: string): string;

Return a fully-qualified gameServerDeployment resource name string.

Parameters
NameDescription
project string
location string
deployment string
Returns
TypeDescription
string

{string} Resource name string.

gameServerDeploymentRolloutPath(project, location, deployment)

gameServerDeploymentRolloutPath(project: string, location: string, deployment: string): string;

Return a fully-qualified gameServerDeploymentRollout resource name string.

Parameters
NameDescription
project string
location string
deployment string
Returns
TypeDescription
string

{string} Resource name string.

getGameServerConfig(request, options)

getGameServerConfig(request?: protos.google.cloud.gaming.v1beta.IGetGameServerConfigRequest, options?: CallOptions): Promise<[protos.google.cloud.gaming.v1beta.IGameServerConfig, protos.google.cloud.gaming.v1beta.IGetGameServerConfigRequest | undefined, {} | undefined]>;

Gets details of a single game server config.

Parameters
NameDescription
request protos.google.cloud.gaming.v1beta.IGetGameServerConfigRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.gaming.v1beta.IGameServerConfig, protos.google.cloud.gaming.v1beta.IGetGameServerConfigRequest | undefined, {} | undefined]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [GameServerConfig]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the game server config to retrieve. Uses the form:
   *  `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`.
   */
  // const name = 'abc123'

  // Imports the Gaming library
  const {GameServerConfigsServiceClient} =
    require('@google-cloud/game-servers').v1beta;

  // Instantiates a client
  const gamingClient = new GameServerConfigsServiceClient();

  async function callGetGameServerConfig() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await gamingClient.getGameServerConfig(request);
    console.log(response);
  }

  callGetGameServerConfig();

getGameServerConfig(request, options, callback)

getGameServerConfig(request: protos.google.cloud.gaming.v1beta.IGetGameServerConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.gaming.v1beta.IGameServerConfig, protos.google.cloud.gaming.v1beta.IGetGameServerConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.gaming.v1beta.IGetGameServerConfigRequest
options CallOptions
callback Callback<protos.google.cloud.gaming.v1beta.IGameServerConfig, protos.google.cloud.gaming.v1beta.IGetGameServerConfigRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getGameServerConfig(request, callback)

getGameServerConfig(request: protos.google.cloud.gaming.v1beta.IGetGameServerConfigRequest, callback: Callback<protos.google.cloud.gaming.v1beta.IGameServerConfig, protos.google.cloud.gaming.v1beta.IGetGameServerConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.gaming.v1beta.IGetGameServerConfigRequest
callback Callback<protos.google.cloud.gaming.v1beta.IGameServerConfig, protos.google.cloud.gaming.v1beta.IGetGameServerConfigRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getProjectId()

getProjectId(): Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
TypeDescription
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

listGameServerConfigs(request, options)

listGameServerConfigs(request?: protos.google.cloud.gaming.v1beta.IListGameServerConfigsRequest, options?: CallOptions): Promise<[protos.google.cloud.gaming.v1beta.IGameServerConfig[], protos.google.cloud.gaming.v1beta.IListGameServerConfigsRequest | null, protos.google.cloud.gaming.v1beta.IListGameServerConfigsResponse]>;

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

Parameters
NameDescription
request protos.google.cloud.gaming.v1beta.IListGameServerConfigsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.gaming.v1beta.IGameServerConfig[], protos.google.cloud.gaming.v1beta.IListGameServerConfigsRequest | null, protos.google.cloud.gaming.v1beta.IListGameServerConfigsResponse]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [GameServerConfig]. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listGameServerConfigsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listGameServerConfigs(request, options, callback)

listGameServerConfigs(request: protos.google.cloud.gaming.v1beta.IListGameServerConfigsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.gaming.v1beta.IListGameServerConfigsRequest, protos.google.cloud.gaming.v1beta.IListGameServerConfigsResponse | null | undefined, protos.google.cloud.gaming.v1beta.IGameServerConfig>): void;
Parameters
NameDescription
request protos.google.cloud.gaming.v1beta.IListGameServerConfigsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.gaming.v1beta.IListGameServerConfigsRequest, protos.google.cloud.gaming.v1beta.IListGameServerConfigsResponse | null | undefined, protos.google.cloud.gaming.v1beta.IGameServerConfig>
Returns
TypeDescription
void

listGameServerConfigs(request, callback)

listGameServerConfigs(request: protos.google.cloud.gaming.v1beta.IListGameServerConfigsRequest, callback: PaginationCallback<protos.google.cloud.gaming.v1beta.IListGameServerConfigsRequest, protos.google.cloud.gaming.v1beta.IListGameServerConfigsResponse | null | undefined, protos.google.cloud.gaming.v1beta.IGameServerConfig>): void;
Parameters
NameDescription
request protos.google.cloud.gaming.v1beta.IListGameServerConfigsRequest
callback PaginationCallback<protos.google.cloud.gaming.v1beta.IListGameServerConfigsRequest, protos.google.cloud.gaming.v1beta.IListGameServerConfigsResponse | null | undefined, protos.google.cloud.gaming.v1beta.IGameServerConfig>
Returns
TypeDescription
void

listGameServerConfigsAsync(request, options)

listGameServerConfigsAsync(request?: protos.google.cloud.gaming.v1beta.IListGameServerConfigsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.gaming.v1beta.IGameServerConfig>;

Equivalent to listGameServerConfigs, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request protos.google.cloud.gaming.v1beta.IListGameServerConfigsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.gaming.v1beta.IGameServerConfig>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [GameServerConfig]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent resource name. Uses the form:
   *  `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/*`.
   */
  // const parent = 'abc123'
  /**
   *  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 google.cloud.gaming.v1beta.ListGameServerConfigsResponse.next_page_token
   *  to determine if there are more GameServerConfigs left to be queried.
   */
  // const pageSize = 1234
  /**
   *  Optional. The next_page_token value returned from a previous list request,
   *  if any.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. The filter to apply to list results.
   */
  // const filter = 'abc123'
  /**
   *  Optional. Specifies the ordering of results following syntax at
   *  https://cloud.google.com/apis/design/design_patterns#sorting_order.
   */
  // const orderBy = 'abc123'

  // Imports the Gaming library
  const {GameServerConfigsServiceClient} =
    require('@google-cloud/game-servers').v1beta;

  // Instantiates a client
  const gamingClient = new GameServerConfigsServiceClient();

  async function callListGameServerConfigs() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await gamingClient.listGameServerConfigsAsync(request);
    for await (const response of iterable) {
      console.log(response);
    }
  }

  callListGameServerConfigs();

listGameServerConfigsStream(request, options)

listGameServerConfigsStream(request?: protos.google.cloud.gaming.v1beta.IListGameServerConfigsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
request protos.google.cloud.gaming.v1beta.IListGameServerConfigsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [GameServerConfig] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listGameServerConfigsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

matchClusterFromGameServerClusterName(gameServerClusterName)

matchClusterFromGameServerClusterName(gameServerClusterName: string): string | number;

Parse the cluster from GameServerCluster resource.

Parameter
NameDescription
gameServerClusterName string

A fully-qualified path representing GameServerCluster resource.

Returns
TypeDescription
string | number

{string} A string representing the cluster.

matchConfigFromGameServerConfigName(gameServerConfigName)

matchConfigFromGameServerConfigName(gameServerConfigName: string): string | number;

Parse the config from GameServerConfig resource.

Parameter
NameDescription
gameServerConfigName string

A fully-qualified path representing GameServerConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the config.

matchDeploymentFromGameServerConfigName(gameServerConfigName)

matchDeploymentFromGameServerConfigName(gameServerConfigName: string): string | number;

Parse the deployment from GameServerConfig resource.

Parameter
NameDescription
gameServerConfigName string

A fully-qualified path representing GameServerConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the deployment.

matchDeploymentFromGameServerDeploymentName(gameServerDeploymentName)

matchDeploymentFromGameServerDeploymentName(gameServerDeploymentName: string): string | number;

Parse the deployment from GameServerDeployment resource.

Parameter
NameDescription
gameServerDeploymentName string

A fully-qualified path representing GameServerDeployment resource.

Returns
TypeDescription
string | number

{string} A string representing the deployment.

matchDeploymentFromGameServerDeploymentRolloutName(gameServerDeploymentRolloutName)

matchDeploymentFromGameServerDeploymentRolloutName(gameServerDeploymentRolloutName: string): string | number;

Parse the deployment from GameServerDeploymentRollout resource.

Parameter
NameDescription
gameServerDeploymentRolloutName string

A fully-qualified path representing GameServerDeploymentRollout resource.

Returns
TypeDescription
string | number

{string} A string representing the deployment.

matchLocationFromGameServerClusterName(gameServerClusterName)

matchLocationFromGameServerClusterName(gameServerClusterName: string): string | number;

Parse the location from GameServerCluster resource.

Parameter
NameDescription
gameServerClusterName string

A fully-qualified path representing GameServerCluster resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromGameServerConfigName(gameServerConfigName)

matchLocationFromGameServerConfigName(gameServerConfigName: string): string | number;

Parse the location from GameServerConfig resource.

Parameter
NameDescription
gameServerConfigName string

A fully-qualified path representing GameServerConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromGameServerDeploymentName(gameServerDeploymentName)

matchLocationFromGameServerDeploymentName(gameServerDeploymentName: string): string | number;

Parse the location from GameServerDeployment resource.

Parameter
NameDescription
gameServerDeploymentName string

A fully-qualified path representing GameServerDeployment resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromGameServerDeploymentRolloutName(gameServerDeploymentRolloutName)

matchLocationFromGameServerDeploymentRolloutName(gameServerDeploymentRolloutName: string): string | number;

Parse the location from GameServerDeploymentRollout resource.

Parameter
NameDescription
gameServerDeploymentRolloutName string

A fully-qualified path representing GameServerDeploymentRollout resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromRealmName(realmName)

matchLocationFromRealmName(realmName: string): string | number;

Parse the location from Realm resource.

Parameter
NameDescription
realmName string

A fully-qualified path representing Realm resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchProjectFromGameServerClusterName(gameServerClusterName)

matchProjectFromGameServerClusterName(gameServerClusterName: string): string | number;

Parse the project from GameServerCluster resource.

Parameter
NameDescription
gameServerClusterName string

A fully-qualified path representing GameServerCluster resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromGameServerConfigName(gameServerConfigName)

matchProjectFromGameServerConfigName(gameServerConfigName: string): string | number;

Parse the project from GameServerConfig resource.

Parameter
NameDescription
gameServerConfigName string

A fully-qualified path representing GameServerConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromGameServerDeploymentName(gameServerDeploymentName)

matchProjectFromGameServerDeploymentName(gameServerDeploymentName: string): string | number;

Parse the project from GameServerDeployment resource.

Parameter
NameDescription
gameServerDeploymentName string

A fully-qualified path representing GameServerDeployment resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromGameServerDeploymentRolloutName(gameServerDeploymentRolloutName)

matchProjectFromGameServerDeploymentRolloutName(gameServerDeploymentRolloutName: string): string | number;

Parse the project from GameServerDeploymentRollout resource.

Parameter
NameDescription
gameServerDeploymentRolloutName string

A fully-qualified path representing GameServerDeploymentRollout resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromRealmName(realmName)

matchProjectFromRealmName(realmName: string): string | number;

Parse the project from Realm resource.

Parameter
NameDescription
realmName string

A fully-qualified path representing Realm resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchRealmFromGameServerClusterName(gameServerClusterName)

matchRealmFromGameServerClusterName(gameServerClusterName: string): string | number;

Parse the realm from GameServerCluster resource.

Parameter
NameDescription
gameServerClusterName string

A fully-qualified path representing GameServerCluster resource.

Returns
TypeDescription
string | number

{string} A string representing the realm.

matchRealmFromRealmName(realmName)

matchRealmFromRealmName(realmName: string): string | number;

Parse the realm from Realm resource.

Parameter
NameDescription
realmName string

A fully-qualified path representing Realm resource.

Returns
TypeDescription
string | number

{string} A string representing the realm.

realmPath(project, location, realm)

realmPath(project: string, location: string, realm: string): string;

Return a fully-qualified realm resource name string.

Parameters
NameDescription
project string
location string
realm string
Returns
TypeDescription
string

{string} Resource name string.