2023-10-04
▼ ▲ gkehub.projects.locations.memberships.delete
Parameter Order: name
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}
HTTP Method: DELETE
Parameters:
requestId
Location: query
Type: string
Description: Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
force
Location: query
Type: boolean
Description: Optional. If set to true, any subresource from this Membership will also be deleted. Otherwise, the request will only work if the Membership has no subresource.
name
Location: path
Description: Required. The Membership resource name in the format `projects/*/locations/*/memberships/*`.
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/memberships/[^/]+$
Path: v1beta/{+name}
Description: Removes a Membership. **This is currently only supported for GKE clusters on Google Cloud**. To unregister other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.
▼ ▲ gkehub.projects.locations.memberships.generateConnectManifest
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}:generateConnectManifest
Path: v1beta/{+name}:generateConnectManifest
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
imagePullSecretContent
Type: string
Format: byte
Description: Optional. The image pull secret content for the registry, if not public.
Location: query
isUpgrade
Location: query
Description: Optional. If true, generate the resources for upgrade only. Some resources generated only for installation (e.g. secrets) will be excluded.
Type: boolean
namespace
Description: Optional. Namespace for GKE Connect agent resources. Defaults to `gke-connect`. The Connect Agent is authorized automatically when run in the default namespace. Otherwise, explicit authorization must be granted with an additional IAM binding.
Type: string
Location: query
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/memberships/[^/]+$
Description: Required. The Membership resource name the Agent will associate with, in the format `projects/*/locations/*/memberships/*`.
Required: Yes
Location: path
version
Type: string
Description: Optional. The Connect agent version to use. Defaults to the most current version.
Location: query
proxy
Format: byte
Type: string
Description: Optional. URI of a proxy if connectivity from the agent to gkeconnect.googleapis.com requires the use of a proxy. Format must be in the form `http(s)://{proxy_address}`, depending on the HTTP/HTTPS protocol supported by the proxy. This will direct the connect agent's outbound traffic through a HTTP(S) proxy.
Location: query
registry
Type: string
Location: query
Description: Optional. The registry to fetch the connect agent image from. Defaults to gcr.io/gkeconnect.
Description: Generates the manifest for deployment of the GKE connect agent. **This method is used internally by Google-provided libraries.** Most clients should not need to call this method directly.
Parameter Order: name
▼ ▲ gkehub.projects.locations.memberships.create
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/memberships
Path: v1beta/{+parent}/memberships
Description: Creates a new Membership. **This is currently only supported for GKE clusters on Google Cloud**. To register other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.
HTTP Method: POST
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
membershipId
Type: string
Location: query
Description: Required. Client chosen ID for the membership. `membership_id` must be a valid RFC 1123 compliant DNS label: 1. At most 63 characters in length 2. It must consist of lower case alphanumeric characters or `-` 3. It must start and end with an alphanumeric character Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`, with a maximum length of 63 characters.
parent
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Description: Required. The parent (project and location) where the Memberships will be created. Specified in the format `projects/*/locations/*`.
requestId
Type: string
Location: query
Description: Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
▼ ▲ gkehub.projects.locations.memberships.list
Path: v1beta/{+parent}/memberships
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/memberships
HTTP Method: GET
Description: Lists Memberships in a given project and location.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
filter
Type: string
Description: Optional. Lists Memberships that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Examples: - Name is `bar` in project `foo-proj` and location `global`: name = "projects/foo-proj/locations/global/membership/bar" - Memberships that have a label called `foo`: labels.foo:* - Memberships that have a label called `foo` whose value is `bar`: labels.foo = bar - Memberships in the CREATING state: state = CREATING
Location: query
pageSize
Location: query
Format: int32
Type: integer
Description: Optional. 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.
pageToken
Type: string
Location: query
Description: Optional. Token returned by previous call to `ListMemberships` which specifies the position in the list from where to continue listing the resources.
parent
Description: Required. The parent (project and location) where the Memberships will be listed. Specified in the format `projects/*/locations/*`. `projects/*/locations/-` list memberships in all the regions.
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
orderBy
Location: query
Type: string
Description: Optional. One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.
Parameter Order: parent
▼ ▲ gkehub.projects.locations.memberships.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
HTTP Method: GET
Parameters:
name
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/memberships/[^/]+$
Description: Required. The Membership resource name in the format `projects/*/locations/*/memberships/*`.
Path: v1beta/{+name}
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}
Description: Gets the details of a Membership.
▼ ▲ gkehub.projects.locations.memberships.patch
Path: v1beta/{+name}
Parameters:
name
Location: path
Type: string
Description: Required. The Membership resource name in the format `projects/*/locations/*/memberships/*`.
Pattern: ^projects/[^/]+/locations/[^/]+/memberships/[^/]+$
Required: Yes
requestId
Description: Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Type: string
Location: query
updateMask
Type: string
Description: Required. Mask of fields to update.
Location: query
Format: google-fieldmask
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates an existing Membership.
HTTP Method: PATCH
Parameter Order: name
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}