Game Services API (gameservices:v1beta)

2023-08-12

9 new methods | New API

Additions

    Methods
  • gameservices.projects.locations.operations.delete

      Path: v1beta/{+name}

      Parameter Order: name

      HTTP Method: DELETE

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        name

          Description: The name of the operation resource to be deleted.

          Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Location: path

          Type: string

          Required: Yes

      Description: 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`.

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

  • gameservices.projects.locations.operations.list

      Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/operations

      Parameters:

        filter

          Description: The standard list filter.

          Type: string

          Location: query

        name

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Required: Yes

          Description: The name of the operation's parent resource.

          Location: path

        pageToken

          Type: string

          Description: The standard list page token.

          Location: query

        pageSize

          Format: int32

          Location: query

          Description: The standard list page size.

          Type: integer

      Path: v1beta/{+name}/operations

      HTTP Method: GET

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • gameservices.projects.locations.operations.get

      Description: 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.

      Scopes: https://www.googleapis.com/auth/cloud-platform

      HTTP Method: GET

      Parameters:

        name

          Type: string

          Description: The name of the operation resource.

          Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Required: Yes

          Location: path

      Path: v1beta/{+name}

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

      Parameter Order: name

  • gameservices.projects.locations.operations.cancel

      Path: v1beta/{+name}:cancel

      Description: 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`.

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        name

          Type: string

          Description: The name of the operation resource to be cancelled.

          Location: path

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

      Parameter Order: name

      HTTP Method: POST

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel

  • gameservices.projects.locations.gameServerDeployments.setIamPolicy

      Path: v1beta/{+resource}:setIamPolicy

      HTTP Method: POST

      Parameters:

        resource

          Pattern: ^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$

          Location: path

          Required: Yes

          Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Type: string

      Parameter Order: resource

      Scopes: https://www.googleapis.com/auth/cloud-platform

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

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}:setIamPolicy

  • gameservices.projects.locations.gameServerDeployments.testIamPermissions

      Parameters:

        resource

          Pattern: ^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$

          Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Required: Yes

          Type: string

          Location: path

      Description: 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.

      HTTP Method: POST

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: resource

      Path: v1beta/{+resource}:testIamPermissions

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}:testIamPermissions

  • gameservices.projects.locations.gameServerDeployments.getIamPolicy

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}:getIamPolicy

      Parameter Order: resource

      Parameters:

        options.requestedPolicyVersion

          Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

          Format: int32

          Location: query

          Type: integer

        resource

          Location: path

          Required: Yes

          Type: string

          Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Pattern: ^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$

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

      Path: v1beta/{+resource}:getIamPolicy

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • gameservices.projects.locations.get

      Parameter Order: name

      HTTP Method: GET

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Gets information about a location.

      Path: v1beta/{+name}

      Parameters:

        name

          Location: path

          Required: Yes

          Description: Resource name for the location.

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Type: string

  • gameservices.projects.locations.list

      Description: Lists information about the supported locations for this service.

      Flat Path: v1beta/projects/{projectsId}/locations

      HTTP Method: GET

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1beta/{+name}/locations

      Parameters:

        pageToken

          Type: string

          Description: A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

          Location: query

        pageSize

          Location: query

          Format: int32

          Type: integer

          Description: The maximum number of results to return. If not set, the service selects a default.

        name

          Required: Yes

          Pattern: ^projects/[^/]+$

          Description: The resource that owns the locations collection, if applicable.

          Type: string

          Location: path

        filter

          Location: query

          Description: A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).

          Type: string

        includeUnrevealedLocations

          Type: boolean

          Location: query

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

9 removed methods | Removed API

Deletions

    Methods
  • gameservices.projects.locations.gameServerDeployments.setIamPolicy

      Parameters:

        resource

          Type: string

          Location: path

          Required: Yes

          Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Pattern: ^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: resource

      HTTP Method: POST

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}:setIamPolicy

      Path: v1beta/{+resource}:setIamPolicy

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

  • gameservices.projects.locations.gameServerDeployments.getIamPolicy

      Parameter Order: resource

      Parameters:

        options.requestedPolicyVersion

          Location: query

          Type: integer

          Format: int32

          Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

        resource

          Type: string

          Location: path

          Required: Yes

          Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Pattern: ^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$

      Scopes: https://www.googleapis.com/auth/cloud-platform

      HTTP Method: GET

      Path: v1beta/{+resource}:getIamPolicy

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

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}:getIamPolicy

  • gameservices.projects.locations.gameServerDeployments.testIamPermissions

      Parameter Order: resource

      Path: v1beta/{+resource}:testIamPermissions

      Parameters:

        resource

          Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Required: Yes

          Type: string

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$

      Description: 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.

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}:testIamPermissions

      HTTP Method: POST

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • gameservices.projects.locations.operations.get

      Parameters:

        name

          Location: path

          Description: The name of the operation resource.

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Required: Yes

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

      Path: v1beta/{+name}

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: 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.

      Parameter Order: name

  • gameservices.projects.locations.operations.delete

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: 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`.

      Parameter Order: name

      HTTP Method: DELETE

      Parameters:

        name

          Description: The name of the operation resource to be deleted.

          Type: string

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Location: path

      Path: v1beta/{+name}

  • gameservices.projects.locations.operations.cancel

      HTTP Method: POST

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel

      Parameter Order: name

      Path: v1beta/{+name}:cancel

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        name

          Description: The name of the operation resource to be cancelled.

          Location: path

          Type: string

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

      Description: 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`.

  • gameservices.projects.locations.operations.list

      Parameter Order: name

      Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/operations

      Path: v1beta/{+name}/operations

      Parameters:

        name

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Description: The name of the operation's parent resource.

          Required: Yes

          Location: path

          Type: string

        pageSize

          Description: The standard list page size.

          Type: integer

          Format: int32

          Location: query

        filter

          Location: query

          Type: string

          Description: The standard list filter.

        pageToken

          Location: query

          Type: string

          Description: The standard list page token.

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • gameservices.projects.locations.list

      Path: v1beta/{+name}/locations

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        includeUnrevealedLocations

          Type: boolean

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

          Location: query

        pageSize

          Location: query

          Description: The maximum number of results to return. If not set, the service selects a default.

          Type: integer

          Format: int32

        pageToken

          Type: string

          Location: query

          Description: A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

        name

          Pattern: ^projects/[^/]+$

          Required: Yes

          Location: path

          Description: The resource that owns the locations collection, if applicable.

          Type: string

        filter

          Description: A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).

          Location: query

          Type: string

      Parameter Order: name

      Flat Path: v1beta/projects/{projectsId}/locations

      Description: Lists information about the supported locations for this service.

  • gameservices.projects.locations.get

      Parameters:

        name

          Required: Yes

          Description: Resource name for the location.

          Location: path

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+$

      Path: v1beta/{+name}

      Description: Gets information about a location.

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}

      Parameter Order: name