# Game Services API . projects . locations . realms . gameServerClusters

## Instance Methods

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

Deletes a single game server cluster.

Gets details of a single game server cluster.

Lists game server clusters in a given project and location.

Retrieves the next page of results.

Patches a single game server cluster.

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

Previews deletion of a single game server cluster.

Previews updating a GameServerCluster.

### Method Details

`create(parent, body=None, gameServerClusterId=None, x__xgafv=None)`

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

    Args:
      parent: string, Required. The parent resource name. Uses the form:
    `projects/{project}/locations/{location}/realms/{realm-id}`. (required)
      body: object, The request body.
        The object takes the form of:

    { # A game server cluster resource.
        "createTime": "A String", # Output only. The creation time.
        "labels": { # The labels associated with this game server cluster. Each label is a
            # key-value pair.
          "a_key": "A String",
        },
        "connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to
            # manage game server clusters.
          "namespace": "A String", # Namespace designated on the game server cluster where the Agones game
              # server instances will be created. Existence of the namespace will be
              # validated during creation.
          "gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
            "cluster": "A String", # The full or partial name of a GKE cluster, using one of the following
                # forms:
                #  * `projects/{project}/locations/{location}/clusters/{cluster}`
                #  * `locations/{location}/clusters/{cluster}`
                #  * `{cluster}`
                # If project and location are not specified, the project and location of the
                # GameServerCluster resource are used to generate the full name of the
                # GKE cluster.
          },
        },
        "etag": "A String", # ETag of the resource.
        "description": "A String", # Human readable description of the cluster.
        "updateTime": "A String", # Output only. The last-modified time.
        "name": "A String", # Required. The resource name of the game server cluster. Uses the form:
            #
            # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
            # For example,
            #
            # `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
      }

      gameServerClusterId: string, Required. The ID of the game server cluster resource to be created.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a
          # network API call.
        "done": True or False, # If the value is `false`, it means the operation is still in progress.
            # If `true`, the operation is completed, and either `error` or `response` is
            # available.
        "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
            # different programming environments, including REST APIs and RPC APIs. It is
            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
            # three pieces of data: error code, error message, and error details.
            #
            # You can find out more about this error model and how to work with it in the
            # [API Design Guide](https://cloud.google.com/apis/design/errors).
          "details": [ # A list of messages that carry the error details.  There is a common set of
              # message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
          "message": "A String", # A developer-facing error message, which should be in English. Any
              # user-facing error message should be localized and sent in the
              # google.rpc.Status.details field, or localized by the client.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        },
        "name": "A String", # The server-assigned name, which is only unique within the same service that
            # originally returns it. If you use the default HTTP mapping, the
            # `name` should be a resource name ending with `operations/{unique_id}`.
        "metadata": { # Service-specific metadata associated with the operation.  It typically
            # contains progress information and common metadata such as create time.
            # Some services might not provide such metadata.  Any method that returns a
            # long-running operation should document the metadata type, if any.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "response": { # The normal response of the operation in case of success.  If the original
            # method returns no data on success, such as `Delete`, the response is
            # `google.protobuf.Empty`.  If the original method is standard
            # `Get`/`Create`/`Update`, the response should be the resource.  For other
            # methods, the response should have the type `XxxResponse`, where `Xxx`
            # is the original method name.  For example, if the original method name
            # is `TakeSnapshot()`, the inferred response type is
            # `TakeSnapshotResponse`.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      }

`delete(name, x__xgafv=None)`

    Deletes a single game server cluster.

    Args:
      name: string, Required. The name of the game server cluster to delete. Uses the form:
    `projects/{project}/locations/{location}/gameServerClusters/{cluster}`. (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a
          # network API call.
        "done": True or False, # If the value is `false`, it means the operation is still in progress.
            # If `true`, the operation is completed, and either `error` or `response` is
            # available.
        "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
            # different programming environments, including REST APIs and RPC APIs. It is
            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
            # three pieces of data: error code, error message, and error details.
            #
            # You can find out more about this error model and how to work with it in the
            # [API Design Guide](https://cloud.google.com/apis/design/errors).
          "details": [ # A list of messages that carry the error details.  There is a common set of
              # message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
          "message": "A String", # A developer-facing error message, which should be in English. Any
              # user-facing error message should be localized and sent in the
              # google.rpc.Status.details field, or localized by the client.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        },
        "name": "A String", # The server-assigned name, which is only unique within the same service that
            # originally returns it. If you use the default HTTP mapping, the
            # `name` should be a resource name ending with `operations/{unique_id}`.
        "metadata": { # Service-specific metadata associated with the operation.  It typically
            # contains progress information and common metadata such as create time.
            # Some services might not provide such metadata.  Any method that returns a
            # long-running operation should document the metadata type, if any.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "response": { # The normal response of the operation in case of success.  If the original
            # method returns no data on success, such as `Delete`, the response is
            # `google.protobuf.Empty`.  If the original method is standard
            # `Get`/`Create`/`Update`, the response should be the resource.  For other
            # methods, the response should have the type `XxxResponse`, where `Xxx`
            # is the original method name.  For example, if the original method name
            # is `TakeSnapshot()`, the inferred response type is
            # `TakeSnapshotResponse`.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      }

`get(name, x__xgafv=None)`

    Gets details of a single game server cluster.

    Args:
      name: string, Required. The name of the game server cluster to retrieve. Uses the form:

    `projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}`. (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # A game server cluster resource.
          "createTime": "A String", # Output only. The creation time.
          "labels": { # The labels associated with this game server cluster. Each label is a
              # key-value pair.
            "a_key": "A String",
          },
          "connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to
              # manage game server clusters.
            "namespace": "A String", # Namespace designated on the game server cluster where the Agones game
                # server instances will be created. Existence of the namespace will be
                # validated during creation.
            "gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
              "cluster": "A String", # The full or partial name of a GKE cluster, using one of the following
                  # forms:
                  #  * `projects/{project}/locations/{location}/clusters/{cluster}`
                  #  * `locations/{location}/clusters/{cluster}`
                  #  * `{cluster}`
                  # If project and location are not specified, the project and location of the
                  # GameServerCluster resource are used to generate the full name of the
                  # GKE cluster.
            },
          },
          "etag": "A String", # ETag of the resource.
          "description": "A String", # Human readable description of the cluster.
          "updateTime": "A String", # Output only. The last-modified time.
          "name": "A String", # Required. The resource name of the game server cluster. Uses the form:
              #
              # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
              # For example,
              #
              # `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
        }

`list(parent, pageToken=None, pageSize=None, orderBy=None, filter=None, x__xgafv=None)`

    Lists game server clusters in a given project and location.

    Args:
      parent: string, Required. The parent resource name. Uses the form:
    "projects/{project}/locations/{location}/realms/{realm}". (required)
      pageToken: string, Optional. The next_page_token value returned from a previous List request, if any.
      pageSize: integer, 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.
      orderBy: string, Optional. Specifies the ordering of results following syntax at
    https://cloud.google.com/apis/design/design_patterns#sorting_order.
      filter: string, Optional. The filter to apply to list results.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Response message for GameServerClustersService.ListGameServerClusters.
        "gameServerClusters": [ # The list of game server clusters.
          { # A game server cluster resource.
              "createTime": "A String", # Output only. The creation time.
              "labels": { # The labels associated with this game server cluster. Each label is a
                  # key-value pair.
                "a_key": "A String",
              },
              "connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to
                  # manage game server clusters.
                "namespace": "A String", # Namespace designated on the game server cluster where the Agones game
                    # server instances will be created. Existence of the namespace will be
                    # validated during creation.
                "gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
                  "cluster": "A String", # The full or partial name of a GKE cluster, using one of the following
                      # forms:
                      #  * `projects/{project}/locations/{location}/clusters/{cluster}`
                      #  * `locations/{location}/clusters/{cluster}`
                      #  * `{cluster}`
                      # If project and location are not specified, the project and location of the
                      # GameServerCluster resource are used to generate the full name of the
                      # GKE cluster.
                },
              },
              "etag": "A String", # ETag of the resource.
              "description": "A String", # Human readable description of the cluster.
              "updateTime": "A String", # Output only. The last-modified time.
              "name": "A String", # Required. The resource name of the game server cluster. Uses the form:
                  #
                  # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
                  # For example,
                  #
                  # `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
            },
        ],
        "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more
            # results in the list.
        "unreachable": [ # List of locations that could not be reached.
          "A String",
        ],
      }

`list_next(previous_request, previous_response)`

    Retrieves the next page of results.

    Args:
      previous_request: The request for the previous page. (required)
      previous_response: The response from the request for the previous page. (required)

    Returns:
      A request object that you can call 'execute()' on to request the next
      page. Returns None if there are no more items in the collection.

`patch(name, body=None, updateMask=None, x__xgafv=None)`

    Patches a single game server cluster.

    Args:
      name: string, Required. The resource name of the game server cluster. Uses the form:

    `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
    For example,

    `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`. (required)
      body: object, The request body.
        The object takes the form of:

    { # A game server cluster resource.
        "createTime": "A String", # Output only. The creation time.
        "labels": { # The labels associated with this game server cluster. Each label is a
            # key-value pair.
          "a_key": "A String",
        },
        "connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to
            # manage game server clusters.
          "namespace": "A String", # Namespace designated on the game server cluster where the Agones game
              # server instances will be created. Existence of the namespace will be
              # validated during creation.
          "gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
            "cluster": "A String", # The full or partial name of a GKE cluster, using one of the following
                # forms:
                #  * `projects/{project}/locations/{location}/clusters/{cluster}`
                #  * `locations/{location}/clusters/{cluster}`
                #  * `{cluster}`
                # If project and location are not specified, the project and location of the
                # GameServerCluster resource are used to generate the full name of the
                # GKE cluster.
          },
        },
        "etag": "A String", # ETag of the resource.
        "description": "A String", # Human readable description of the cluster.
        "updateTime": "A String", # Output only. The last-modified time.
        "name": "A String", # Required. The resource name of the game server cluster. Uses the form:
            #
            # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
            # For example,
            #
            # `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
      }

      updateMask: string, 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
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a
          # network API call.
        "done": True or False, # If the value is `false`, it means the operation is still in progress.
            # If `true`, the operation is completed, and either `error` or `response` is
            # available.
        "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
            # different programming environments, including REST APIs and RPC APIs. It is
            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
            # three pieces of data: error code, error message, and error details.
            #
            # You can find out more about this error model and how to work with it in the
            # [API Design Guide](https://cloud.google.com/apis/design/errors).
          "details": [ # A list of messages that carry the error details.  There is a common set of
              # message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
          "message": "A String", # A developer-facing error message, which should be in English. Any
              # user-facing error message should be localized and sent in the
              # google.rpc.Status.details field, or localized by the client.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        },
        "name": "A String", # The server-assigned name, which is only unique within the same service that
            # originally returns it. If you use the default HTTP mapping, the
            # `name` should be a resource name ending with `operations/{unique_id}`.
        "metadata": { # Service-specific metadata associated with the operation.  It typically
            # contains progress information and common metadata such as create time.
            # Some services might not provide such metadata.  Any method that returns a
            # long-running operation should document the metadata type, if any.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "response": { # The normal response of the operation in case of success.  If the original
            # method returns no data on success, such as `Delete`, the response is
            # `google.protobuf.Empty`.  If the original method is standard
            # `Get`/`Create`/`Update`, the response should be the resource.  For other
            # methods, the response should have the type `XxxResponse`, where `Xxx`
            # is the original method name.  For example, if the original method name
            # is `TakeSnapshot()`, the inferred response type is
            # `TakeSnapshotResponse`.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      }

`previewCreate(parent, body=None, previewTime=None, gameServerClusterId=None, x__xgafv=None)`

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

    Args:
      parent: string, Required. The parent resource name. Uses the form:
    `projects/{project}/locations/{location}/realms/{realm}`. (required)
      body: object, The request body.
        The object takes the form of:

    { # A game server cluster resource.
        "createTime": "A String", # Output only. The creation time.
        "labels": { # The labels associated with this game server cluster. Each label is a
            # key-value pair.
          "a_key": "A String",
        },
        "connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to
            # manage game server clusters.
          "namespace": "A String", # Namespace designated on the game server cluster where the Agones game
              # server instances will be created. Existence of the namespace will be
              # validated during creation.
          "gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
            "cluster": "A String", # The full or partial name of a GKE cluster, using one of the following
                # forms:
                #  * `projects/{project}/locations/{location}/clusters/{cluster}`
                #  * `locations/{location}/clusters/{cluster}`
                #  * `{cluster}`
                # If project and location are not specified, the project and location of the
                # GameServerCluster resource are used to generate the full name of the
                # GKE cluster.
          },
        },
        "etag": "A String", # ETag of the resource.
        "description": "A String", # Human readable description of the cluster.
        "updateTime": "A String", # Output only. The last-modified time.
        "name": "A String", # Required. The resource name of the game server cluster. Uses the form:
            #
            # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
            # For example,
            #
            # `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
      }

      previewTime: string, Optional. The target timestamp to compute the preview.
      gameServerClusterId: string, Required. The ID of the game server cluster resource to be created.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Response message for
          # GameServerClustersService.PreviewCreateGameServerCluster.
        "targetState": { # Encapsulates the Target state. # The target state.
          "details": [ # Details about Agones fleets.
            { # Details about the Agones resources.
              "fleetDetails": [ # Agones fleet details for game server clusters and game server deployments.
                { # Details of the target Agones fleet.
                  "fleet": { # Target Agones fleet specification. # Reference to target Agones fleet.
                    "name": "A String", # The name of the Agones fleet.
                    "specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec.
                        # The Agones fleet spec source.
                      "gameServerConfigName": "A String", # The game server config resource. Uses the form:
                          #
                          # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
                      "name": "A String", # The name of the Agones leet config or Agones scaling config used to derive
                          # the Agones fleet or Agones autoscaler spec.
                    },
                  },
                  "autoscaler": { # Target Agones autoscaler policy reference. # Reference to target Agones fleet autoscaling policy.
                    "name": "A String", # The name of the Agones autoscaler.
                    "specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec.
                        # Details about the Agones autoscaler spec.
                      "gameServerConfigName": "A String", # The game server config resource. Uses the form:
                          #
                          # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
                      "name": "A String", # The name of the Agones leet config or Agones scaling config used to derive
                          # the Agones fleet or Agones autoscaler spec.
                    },
                  },
                },
              ],
              "gameServerClusterName": "A String", # The game server cluster name. Uses the form:
                  #
                  # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
              "gameServerDeploymentName": "A String", # The game server deployment name. Uses the form:
                  #
                  # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.
            },
          ],
        },
        "etag": "A String", # The ETag of the game server cluster.
      }

`previewDelete(name, previewTime=None, x__xgafv=None)`

    Previews deletion of a single game server cluster.

    Args:
      name: string, Required. The name of the game server cluster to delete. Uses the form:
    `projects/{project}/locations/{location}/gameServerClusters/{cluster}`. (required)
      previewTime: string, Optional. The target timestamp to compute the preview.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Response message for
          # GameServerClustersService.PreviewDeleteGameServerCluster.
        "targetState": { # Encapsulates the Target state. # The target state.
          "details": [ # Details about Agones fleets.
            { # Details about the Agones resources.
              "fleetDetails": [ # Agones fleet details for game server clusters and game server deployments.
                { # Details of the target Agones fleet.
                  "fleet": { # Target Agones fleet specification. # Reference to target Agones fleet.
                    "name": "A String", # The name of the Agones fleet.
                    "specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec.
                        # The Agones fleet spec source.
                      "gameServerConfigName": "A String", # The game server config resource. Uses the form:
                          #
                          # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
                      "name": "A String", # The name of the Agones leet config or Agones scaling config used to derive
                          # the Agones fleet or Agones autoscaler spec.
                    },
                  },
                  "autoscaler": { # Target Agones autoscaler policy reference. # Reference to target Agones fleet autoscaling policy.
                    "name": "A String", # The name of the Agones autoscaler.
                    "specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec.
                        # Details about the Agones autoscaler spec.
                      "gameServerConfigName": "A String", # The game server config resource. Uses the form:
                          #
                          # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
                      "name": "A String", # The name of the Agones leet config or Agones scaling config used to derive
                          # the Agones fleet or Agones autoscaler spec.
                    },
                  },
                },
              ],
              "gameServerClusterName": "A String", # The game server cluster name. Uses the form:
                  #
                  # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
              "gameServerDeploymentName": "A String", # The game server deployment name. Uses the form:
                  #
                  # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.
            },
          ],
        },
        "etag": "A String", # The ETag of the game server cluster.
      }

`previewUpdate(name, body=None, updateMask=None, previewTime=None, x__xgafv=None)`

    Previews updating a GameServerCluster.

    Args:
      name: string, Required. The resource name of the game server cluster. Uses the form:

    `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
    For example,

    `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`. (required)
      body: object, The request body.
        The object takes the form of:

    { # A game server cluster resource.
        "createTime": "A String", # Output only. The creation time.
        "labels": { # The labels associated with this game server cluster. Each label is a
            # key-value pair.
          "a_key": "A String",
        },
        "connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to
            # manage game server clusters.
          "namespace": "A String", # Namespace designated on the game server cluster where the Agones game
              # server instances will be created. Existence of the namespace will be
              # validated during creation.
          "gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
            "cluster": "A String", # The full or partial name of a GKE cluster, using one of the following
                # forms:
                #  * `projects/{project}/locations/{location}/clusters/{cluster}`
                #  * `locations/{location}/clusters/{cluster}`
                #  * `{cluster}`
                # If project and location are not specified, the project and location of the
                # GameServerCluster resource are used to generate the full name of the
                # GKE cluster.
          },
        },
        "etag": "A String", # ETag of the resource.
        "description": "A String", # Human readable description of the cluster.
        "updateTime": "A String", # Output only. The last-modified time.
        "name": "A String", # Required. The resource name of the game server cluster. Uses the form:
            #
            # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
            # For example,
            #
            # `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
      }

      updateMask: string, 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
      previewTime: string, Optional. The target timestamp to compute the preview.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Response message for GameServerClustersService.PreviewUpdateGameServerCluster
        "targetState": { # Encapsulates the Target state. # The target state.
          "details": [ # Details about Agones fleets.
            { # Details about the Agones resources.
              "fleetDetails": [ # Agones fleet details for game server clusters and game server deployments.
                { # Details of the target Agones fleet.
                  "fleet": { # Target Agones fleet specification. # Reference to target Agones fleet.
                    "name": "A String", # The name of the Agones fleet.
                    "specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec.
                        # The Agones fleet spec source.
                      "gameServerConfigName": "A String", # The game server config resource. Uses the form:
                          #
                          # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
                      "name": "A String", # The name of the Agones leet config or Agones scaling config used to derive
                          # the Agones fleet or Agones autoscaler spec.
                    },
                  },
                  "autoscaler": { # Target Agones autoscaler policy reference. # Reference to target Agones fleet autoscaling policy.
                    "name": "A String", # The name of the Agones autoscaler.
                    "specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec.
                        # Details about the Agones autoscaler spec.
                      "gameServerConfigName": "A String", # The game server config resource. Uses the form:
                          #
                          # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
                      "name": "A String", # The name of the Agones leet config or Agones scaling config used to derive
                          # the Agones fleet or Agones autoscaler spec.
                    },
                  },
                },
              ],
              "gameServerClusterName": "A String", # The game server cluster name. Uses the form:
                  #
                  # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
              "gameServerDeploymentName": "A String", # The game server deployment name. Uses the form:
                  #
                  # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.
            },
          ],
        },
        "etag": "A String", # The ETag of the game server cluster.
      }