GKE Hub API (gkehub:v2beta)

2024-08-15

5 removed methods | Removed API

Deletions

    Methods

  • ▼ ▲ gkehub.projects.locations.list

      Path: v2beta/{+name}/locations

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

      HTTP Method: GET

      Parameters:

        name

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

          Pattern: ^projects/[^/]+$

          Location: path

          Required: Yes

          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

        pageSize

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

          Location: query

          Type: integer

          Format: int32

        pageToken

          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

          Type: string

      Parameter Order: name

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

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

  • ▼ ▲ gkehub.projects.locations.get

      Path: v2beta/{+name}

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

      HTTP Method: GET

      Parameters:

        name

          Description: Resource name for the location.

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Gets information about a location.

  • ▼ ▲ gkehub.projects.locations.operations.list

      Path: v2beta/{+name}/operations

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

      HTTP Method: GET

      Parameters:

        name

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

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

          Location: path

          Required: Yes

          Type: string

        filter

          Description: The standard list filter.

          Location: query

          Type: string

        pageSize

          Description: The standard list page size.

          Location: query

          Type: integer

          Format: int32

        pageToken

          Description: The standard list page token.

          Location: query

          Type: string

      Parameter Order: name

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

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

  • ▼ ▲ gkehub.projects.locations.operations.get

      Path: v2beta/{+name}

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

      HTTP Method: GET

      Parameters:

        name

          Description: The name of the operation resource.

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      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.

  • ▼ ▲ gkehub.projects.locations.operations.cancel

      Path: v2beta/{+name}:cancel

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

      HTTP Method: POST

      Parameters:

        name

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

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

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

5 new methods | New API

Additions

    Methods

  • ▼ ▲ gkehub.projects.locations.list

      Path: v2beta/{+name}/locations

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

      HTTP Method: GET

      Parameters:

        name

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

          Pattern: ^projects/[^/]+$

          Location: path

          Required: Yes

          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

        pageSize

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

          Location: query

          Type: integer

          Format: int32

        pageToken

          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

          Type: string

      Parameter Order: name

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

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

  • ▼ ▲ gkehub.projects.locations.get

      Path: v2beta/{+name}

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

      HTTP Method: GET

      Parameters:

        name

          Description: Resource name for the location.

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Gets information about a location.

  • ▼ ▲ gkehub.projects.locations.operations.list

      Path: v2beta/{+name}/operations

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

      HTTP Method: GET

      Parameters:

        name

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

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

          Location: path

          Required: Yes

          Type: string

        filter

          Description: The standard list filter.

          Location: query

          Type: string

        pageSize

          Description: The standard list page size.

          Location: query

          Type: integer

          Format: int32

        pageToken

          Description: The standard list page token.

          Location: query

          Type: string

      Parameter Order: name

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

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

  • ▼ ▲ gkehub.projects.locations.operations.get

      Path: v2beta/{+name}

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

      HTTP Method: GET

      Parameters:

        name

          Description: The name of the operation resource.

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      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.

  • ▼ ▲ gkehub.projects.locations.operations.cancel

      Path: v2beta/{+name}:cancel

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

      HTTP Method: POST

      Parameters:

        name

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

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

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