GKE Hub API (gkehub:v1beta)

2023-04-15

6 new methods

Additions

    Methods
  • gkehub.organizations.locations.fleets.list

      HTTP Method: GET

      Description: Returns all fleets within an organization or a project that the caller has access to.

      Path: v1beta/{+parent}/fleets

      Flat Path: v1beta/organizations/{organizationsId}/locations/{locationsId}/fleets

      Parameters:

        parent

          Location: path

          Description: Required. The organization or project to list for Fleets under, in the format `organizations/*/locations/*` or `projects/*/locations/*`.

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

          Type: string

          Required: Yes

        pageToken

          Type: string

          Description: Optional. A page token, received from a previous `ListFleets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFleets` must match the call that provided the page token.

          Location: query

        pageSize

          Description: Optional. The maximum number of fleets to return. The service may return fewer than this value. If unspecified, at most 200 fleets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

          Type: integer

          Location: query

          Format: int32

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

      Parameter Order: parent

  • gkehub.projects.locations.fleets.delete

      Path: v1beta/{+name}

      HTTP Method: DELETE

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

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

      Parameter Order: name

      Description: Removes a Fleet. There must be no memberships remaining in the Fleet.

      Parameters:

        name

          Location: path

          Required: Yes

          Description: Required. The Fleet resource name in the format `projects/*/locations/*/fleets/*`.

          Type: string

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

  • gkehub.projects.locations.fleets.list

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

      Description: Returns all fleets within an organization or a project that the caller has access to.

      HTTP Method: GET

      Parameters:

        pageToken

          Location: query

          Type: string

          Description: Optional. A page token, received from a previous `ListFleets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFleets` must match the call that provided the page token.

        pageSize

          Location: query

          Description: Optional. The maximum number of fleets to return. The service may return fewer than this value. If unspecified, at most 200 fleets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

          Type: integer

          Format: int32

        parent

          Type: string

          Description: Required. The organization or project to list for Fleets under, in the format `organizations/*/locations/*` or `projects/*/locations/*`.

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

          Location: path

          Required: Yes

      Path: v1beta/{+parent}/fleets

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

      Parameter Order: parent

  • gkehub.projects.locations.fleets.create

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

      Parameters:

        parent

          Required: Yes

          Description: Required. The parent (project and location) where the Fleet will be created. Specified in the format `projects/*/locations/*`.

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

          Type: string

          Location: path

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

      Path: v1beta/{+parent}/fleets

      HTTP Method: POST

      Parameter Order: parent

      Description: Creates a fleet.

  • gkehub.projects.locations.fleets.get

      Parameter Order: name

      Parameters:

        name

          Type: string

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

          Description: Required. The Fleet resource name in the format `projects/*/locations/*/fleets/*`.

          Location: path

          Required: Yes

      HTTP Method: GET

      Path: v1beta/{+name}

      Description: Returns the details of a fleet.

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

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

  • gkehub.projects.locations.fleets.patch

      Parameter Order: name

      Description: Updates a fleet.

      Path: v1beta/{+name}

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

      HTTP Method: PATCH

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

      Parameters:

        name

          Location: path

          Required: Yes

          Type: string

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

          Description: Output only. The full, unique resource name of this fleet in the format of `projects/{project}/locations/{location}/fleets/{fleet}`. Each GCP project can have at most one fleet resource, named "default".

        updateMask

          Description: Required. The fields to be updated;

          Type: string

          Location: query

          Format: google-fieldmask