GKE Hub API (gkehub:v2alpha)

2022-02-12

14 new methods | New API

Additions

    Methods
  • gkehub.projects.locations.operations.get

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

      Parameters:

        name

          Location: path

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

          Required: Yes

          Type: string

          Description: The name of the operation resource.

      HTTP Method: GET

      Parameter Order: name

      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.

      Path: v2alpha/{+name}

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

  • gkehub.projects.locations.operations.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`.

      Path: v2alpha/{+name}:cancel

      Parameters:

        name

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

          Type: string

          Required: Yes

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

          Location: path

      Parameter Order: name

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

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

      HTTP Method: POST

  • gkehub.projects.locations.operations.list

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

      HTTP Method: GET

      Parameter Order: name

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

      Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

      Path: v2alpha/{+name}/operations

      Parameters:

        pageSize

          Location: query

          Description: The standard list page size.

          Type: integer

          Format: int32

        filter

          Description: The standard list filter.

          Type: string

          Location: query

        pageToken

          Description: The standard list page token.

          Type: string

          Location: query

        name

          Type: string

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

          Required: Yes

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

          Location: path

  • gkehub.projects.locations.memberships.features.list

      Parameter Order: parent

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

      HTTP Method: GET

      Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}/features

      Description: Lists MembershipFeatures in a given project and location.

      Path: v2alpha/{+parent}/features

      Parameters:

        filter

          Type: string

          Location: query

          Description: Lists MembershipFeatures that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Examples: - Feature with the name "helloworld" in project "foo-proj" and membership "member-bar": name = "projects/foo-proj/locations/global/memberships/member-bar/features/helloworld" - Features that have a label called `foo`: labels.foo:* - Features that have a label called `foo` whose value is `bar`: labels.foo = bar

        pageToken

          Location: query

          Description: Token returned by previous call to `ListFeatures` which specifies the position in the list from where to continue listing the resources.

          Type: string

        parent

          Required: Yes

          Type: string

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

          Description: Required. The parent where the MembershipFeature will be listed. In the format: `projects/*/locations/*/memberships/*`.

          Location: path

        orderBy

          Type: string

          Location: query

          Description: One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.

        pageSize

          Format: int32

          Location: query

          Description: When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned.

          Type: integer

  • gkehub.projects.locations.memberships.features.patch

      Parameter Order: name

      HTTP Method: PATCH

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

      Path: v2alpha/{+name}

      Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}/features/{featuresId}

      Description: Updates an existing MembershipFeature.

      Parameters:

        requestId

          Type: string

          Description: Idempotent request UUID.

          Location: query

        updateMask

          Location: query

          Description: Required. Mask of fields to update.

          Type: string

          Format: google-fieldmask

        name

          Type: string

          Description: Output only. The resource name of the membershipFeature, in the format: `projects/{project}/locations/{location}/memberships/{membership}/features/{feature}`. Note that `membershipFeatures` is shortened to `features` in the resource name. (see http://go/aip/122#collection-identifiers)

          Required: Yes

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

          Location: path

  • gkehub.projects.locations.memberships.features.create

      Path: v2alpha/{+parent}/features

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

      Parameters:

        requestId

          Description: Idempotent request UUID.

          Location: query

          Type: string

        parent

          Required: Yes

          Type: string

          Location: path

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

          Description: Required. The name of parent where the MembershipFeature will be created. Specified in the format `projects/*/locations/*/memberships/*/features/*`.

      Parameter Order: parent

      HTTP Method: POST

      Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}/features

      Description: Creates membershipFeature under a given parent.

  • gkehub.projects.locations.memberships.features.delete

      Parameters:

        name

          Location: path

          Description: Required. The name of the membershipFeature to be deleted. Specified in the format `projects/*/locations/*/memberships/*/features/*`.

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

          Required: Yes

          Type: string

        requestId

          Type: string

          Location: query

          Description: Idempotent request UUID.

      Parameter Order: name

      Path: v2alpha/{+name}

      HTTP Method: DELETE

      Description: Removes a membershipFeature.

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

      Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}/features/{featuresId}

  • gkehub.projects.locations.memberships.features.get

      HTTP Method: GET

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

      Description: ========= MembershipFeature Services ========= Gets details of a membershipFeature.

      Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}/features/{featuresId}

      Parameters:

        name

          Location: path

          Type: string

          Description: Required. The MembershipFeature resource name in the format `projects/*/locations/*/memberships/*/features/*`.

          Required: Yes

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

      Parameter Order: name

      Path: v2alpha/{+name}

  • gkehub.projects.locations.featureConfigs.list

      Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/featureConfigs

      Parameter Order: parent

      Path: v2alpha/{+parent}/featureConfigs

      Parameters:

        pageToken

          Location: query

          Description: Token returned by previous call to `ListFeatures` which specifies the position in the list from where to continue listing the resources.

          Type: string

        pageSize

          Description: When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned.

          Format: int32

          Type: integer

          Location: query

        filter

          Location: query

          Type: string

          Description: Lists FeatureConfigs that match the filter expression, following the syntax outlined in https://google.aip.dev/160.

        parent

          Description: Required. The parent where the FeatureConfigs will be listed. In the format: `projects/*/locations/*`.

          Location: path

          Type: string

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

          Required: Yes

        orderBy

          Type: string

          Description: One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.

          Location: query

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

      HTTP Method: GET

      Description: Lists all FeatureConfigs in a given project and location.

  • gkehub.projects.locations.featureConfigs.create

      Description: Creates FeatureConfig under a given parent.

      Parameters:

        parent

          Type: string

          Description: Required. The name of parent where the FeatureConfig will be created. Specified in the format `projects/{project}/locations/global/featureConfigs/{feature_type}/{feature_config}/`.

          Location: path

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

          Required: Yes

        featureConfigId

          Type: string

          Description: The ID of the feature config to create.

          Location: query

        requestId

          Type: string

          Location: query

          Description: Idempotent request UUID.

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

      Path: v2alpha/{+parent}/featureConfigs

      Parameter Order: parent

      HTTP Method: POST

      Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/featureConfigs

  • gkehub.projects.locations.featureConfigs.delete

      Parameters:

        requestId

          Location: query

          Type: string

          Description: Idempotent request UUID.

        name

          Description: Required. The name of the membershipFeature to be deleted. Specified in the format `projects/*/locations/*/featureConfigs/**`.

          Pattern: ^projects/[^/]+/locations/[^/]+/featureConfigs/.*$

          Required: Yes

          Type: string

          Location: path

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

      Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/featureConfigs/{featureConfigsId}

      Description: Removes a FeatureConfig.

      Path: v2alpha/{+name}

      HTTP Method: DELETE

      Parameter Order: name

  • gkehub.projects.locations.featureConfigs.get

      Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/featureConfigs/{featureConfigsId}

      Description: ========= FeatureConfig Services ========= Gets details of a featureConfig.

      Parameter Order: name

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

      HTTP Method: GET

      Path: v2alpha/{+name}

      Parameters:

        name

          Pattern: ^projects/[^/]+/locations/[^/]+/featureConfigs/.*$

          Required: Yes

          Location: path

          Type: string

          Description: Required. The FeatureConfig resource name in the format `projects/*/locations/*/featureConfigs/**`.

  • gkehub.projects.locations.get

      HTTP Method: GET

      Parameters:

        name

          Required: Yes

          Description: Resource name for the location.

          Location: path

          Type: string

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

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

      Description: Gets information about a location.

      Parameter Order: name

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

      Path: v2alpha/{+name}

  • gkehub.projects.locations.list

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

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

      Parameters:

        name

          Location: path

          Pattern: ^projects/[^/]+$

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

          Type: string

          Required: Yes

        pageSize

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

          Location: query

          Format: int32

          Type: integer

        filter

          Type: string

          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

        pageToken

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

          Type: string

          Location: query

      Path: v2alpha/{+name}/locations

      Parameter Order: name

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

      HTTP Method: GET