GKE Hub API (gkehub:v1)

2023-06-17

7 new methods

Additions

    Methods
  • gkehub.organizations.locations.fleets.list

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

      Parameter Order : parent

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

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

      HTTP Method : GET

      Path : v1/{+parent}/fleets

      Parameters :

        pageSize

          Type : integer

          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.

          Format : int32

          Location : query

        parent

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

          Location : path

          Description : Required. The organization or project to list for Fleets under, in the format `organizations/*/locations/*` or `projects/*/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

  • gkehub.projects.locations.scopes.patch

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}

      Description : Updates a scopes.

      Parameter Order : name

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

      Parameters :

        name

          Type : string

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

          Description : The resource name for the scope `projects/{project}/locations/{location}/scopes/{scope}`

          Required : Yes

          Location : path

        updateMask

          Location : query

          Description : Required. The fields to be updated.

          Type : string

          Format : google-fieldmask

      HTTP Method : PATCH

      Path : v1/{+name}

  • gkehub.projects.locations.fleets.get

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

      Parameter Order : name

      Description : Returns the details of a fleet.

      Parameters :

        name

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

          Location : path

          Required : Yes

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

          Type : string

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

      Path : v1/{+name}

      HTTP Method : GET

  • gkehub.projects.locations.fleets.create

      Parameters :

        parent

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

          Required : Yes

          Location : path

          Type : string

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

      Description : Creates a fleet.

      Path : v1/{+parent}/fleets

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

      HTTP Method : POST

      Parameter Order : parent

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

  • gkehub.projects.locations.fleets.list

      HTTP Method : GET

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

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

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

      Parameter Order : parent

      Parameters :

        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

          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

          Location : path

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

          Type : string

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

          Required : Yes

      Path : v1/{+parent}/fleets

  • gkehub.projects.locations.fleets.delete

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

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

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

      HTTP Method : DELETE

      Path : v1/{+name}

      Parameters :

        name

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

          Required : Yes

          Type : string

          Location : path

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

      Parameter Order : name

  • gkehub.projects.locations.fleets.patch

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

      Parameters :

        updateMask

          Type : string

          Location : query

          Description : Required. The fields to be updated;

          Format : google-fieldmask

        name

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

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

          Required : Yes

          Location : path

          Type : string

      Description : Updates a fleet.

      Path : v1/{+name}

      Parameter Order : name

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

      HTTP Method : PATCH