Game Services API . projects . locations . realms

Instance Methods

gameServerClusters()

Returns the gameServerClusters Resource.

create(parent, body=None, realmId=None, x__xgafv=None)

Creates a new realm in a given project and location.

delete(name, x__xgafv=None)

Deletes a single realm.

get(name, x__xgafv=None)

Gets details of a single realm.

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

Lists realms in a given project and location.

list_next(previous_request, previous_response)

Retrieves the next page of results.

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

Patches a single realm.

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

Previews patches to a single realm.

Method Details

create(parent, body=None, realmId=None, x__xgafv=None)
Creates a new realm in a given project and location.

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

{ # A realm resource.
  "etag": "A String", # ETag of the resource.
  "createTime": "A String", # Output only. The creation time.
  "labels": { # The labels associated with this realm. Each label is a key-value pair.
    "a_key": "A String",
  },
  "updateTime": "A String", # Output only. The last-modified time.
  "name": "A String", # The resource name of the realm. Uses the form:
      # `projects/{project}/locations/{location}/realms/{realm}`. For
      # example, `projects/my-project/locations/{location}/realms/my-realm`.
  "timeZone": "A String", # Required. Time zone where all policies targeting this realm are evaluated. The value
      # of this field must be from the IANA time zone database:
      # https://www.iana.org/time-zones.
  "description": "A String", # Human readable description of the realm.
}

  realmId: string, Required. The ID of the realm 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.
    "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.
    },
    "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}`.
    "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).
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "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.
      "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.
        },
      ],
    },
    "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.
    },
  }
delete(name, x__xgafv=None)
Deletes a single realm.

Args:
  name: string, Required. The name of the realm to delete. Uses the form:
`projects/{project}/locations/{location}/realms/{realm}`. (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.
    "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.
    },
    "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}`.
    "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).
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "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.
      "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.
        },
      ],
    },
    "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.
    },
  }
get(name, x__xgafv=None)
Gets details of a single realm.

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

Returns:
  An object of the form:

    { # A realm resource.
    "etag": "A String", # ETag of the resource.
    "createTime": "A String", # Output only. The creation time.
    "labels": { # The labels associated with this realm. Each label is a key-value pair.
      "a_key": "A String",
    },
    "updateTime": "A String", # Output only. The last-modified time.
    "name": "A String", # The resource name of the realm. Uses the form:
        # `projects/{project}/locations/{location}/realms/{realm}`. For
        # example, `projects/my-project/locations/{location}/realms/my-realm`.
    "timeZone": "A String", # Required. Time zone where all policies targeting this realm are evaluated. The value
        # of this field must be from the IANA time zone database:
        # https://www.iana.org/time-zones.
    "description": "A String", # Human readable description of the realm.
  }
list(parent, filter=None, pageToken=None, orderBy=None, pageSize=None, x__xgafv=None)
Lists realms in a given project and location.

Args:
  parent: string, Required. The parent resource name. Uses the form:
`projects/{project}/locations/{location}`. (required)
  filter: string, Optional. The filter to apply to list results.
  pageToken: string, Optional. The next_page_token value returned from a previous List request,
if any.
  orderBy: string, Optional. Specifies the ordering of results following syntax at
https://cloud.google.com/apis/design/design_patterns#sorting_order.
  pageSize: integer, 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.
  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 RealmsService.ListRealms.
    "realms": [ # The list of realms.
      { # A realm resource.
        "etag": "A String", # ETag of the resource.
        "createTime": "A String", # Output only. The creation time.
        "labels": { # The labels associated with this realm. Each label is a key-value pair.
          "a_key": "A String",
        },
        "updateTime": "A String", # Output only. The last-modified time.
        "name": "A String", # The resource name of the realm. Uses the form:
            # `projects/{project}/locations/{location}/realms/{realm}`. For
            # example, `projects/my-project/locations/{location}/realms/my-realm`.
        "timeZone": "A String", # Required. Time zone where all policies targeting this realm are evaluated. The value
            # of this field must be from the IANA time zone database:
            # https://www.iana.org/time-zones.
        "description": "A String", # Human readable description of the realm.
      },
    ],
    "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 realm.

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

{ # A realm resource.
  "etag": "A String", # ETag of the resource.
  "createTime": "A String", # Output only. The creation time.
  "labels": { # The labels associated with this realm. Each label is a key-value pair.
    "a_key": "A String",
  },
  "updateTime": "A String", # Output only. The last-modified time.
  "name": "A String", # The resource name of the realm. Uses the form:
      # `projects/{project}/locations/{location}/realms/{realm}`. For
      # example, `projects/my-project/locations/{location}/realms/my-realm`.
  "timeZone": "A String", # Required. Time zone where all policies targeting this realm are evaluated. The value
      # of this field must be from the IANA time zone database:
      # https://www.iana.org/time-zones.
  "description": "A String", # Human readable description of the realm.
}

  updateMask: string, Required. The update mask applies to the resource. 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.
    "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.
    },
    "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}`.
    "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).
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "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.
      "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.
        },
      ],
    },
    "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.
    },
  }
previewUpdate(name, body=None, updateMask=None, previewTime=None, x__xgafv=None)
Previews patches to a single realm.

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

{ # A realm resource.
  "etag": "A String", # ETag of the resource.
  "createTime": "A String", # Output only. The creation time.
  "labels": { # The labels associated with this realm. Each label is a key-value pair.
    "a_key": "A String",
  },
  "updateTime": "A String", # Output only. The last-modified time.
  "name": "A String", # The resource name of the realm. Uses the form:
      # `projects/{project}/locations/{location}/realms/{realm}`. For
      # example, `projects/my-project/locations/{location}/realms/my-realm`.
  "timeZone": "A String", # Required. Time zone where all policies targeting this realm are evaluated. The value
      # of this field must be from the IANA time zone database:
      # https://www.iana.org/time-zones.
  "description": "A String", # Human readable description of the realm.
}

  updateMask: string, Required. The update mask applies to the resource. 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 RealmsService.PreviewRealmUpdate.
    "etag": "A String", # ETag of the realm.
    "targetState": { # Encapsulates the Target state. # The target state.
      "details": [ # Details about Agones fleets.
        { # Details about the Agones resources.
          "gameServerDeploymentName": "A String", # The game server deployment name. Uses the form:
              #
              # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.
          "fleetDetails": [ # Agones fleet details for game server clusters and game server deployments.
            { # Details of the target Agones fleet.
              "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.
                  "name": "A String", # The name of the Agones leet config or Agones scaling config used to derive
                      # the Agones fleet or Agones autoscaler spec.
                  "gameServerConfigName": "A String", # The game server config resource. Uses the form:
                      #
                      # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
                },
              },
              "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.
                  "name": "A String", # The name of the Agones leet config or Agones scaling config used to derive
                      # the Agones fleet or Agones autoscaler spec.
                  "gameServerConfigName": "A String", # The game server config resource. Uses the form:
                      #
                      # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
                },
              },
            },
          ],
          "gameServerClusterName": "A String", # The game server cluster name. Uses the form:
              #
              # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
        },
      ],
    },
  }