2023-10-05
▼ ▲ gkehub.projects.locations.memberships.generateConnectManifest
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.
Parameters:
registry
Type: string
Location: query
Description: Optional. The registry to fetch the connect agent image from. Defaults to gcr.io/gkeconnect.
namespace
Location: query
Type: string
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.
imagePullSecretContent
Type: string
Format: byte
Location: query
Description: Optional. The image pull secret content for the registry, if not public.
proxy
Location: query
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.
Format: byte
isUpgrade
Location: query
Type: boolean
Description: Optional. If true, generate the resources for upgrade only. Some resources generated only for installation (e.g. secrets) will be excluded.
name
Type: string
Required: Yes
Description: Required. The Membership resource name the Agent will associate with, in the format `projects/*/locations/*/memberships/*`.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/memberships/[^/]+$
version
Description: Optional. The Connect agent version to use. Defaults to the most current version.
Type: string
Location: query
HTTP Method: GET
Path: v1beta/{+name}:generateConnectManifest
Parameter Order: name
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}:generateConnectManifest
▼ ▲ gkehub.projects.locations.memberships.create
HTTP Method: POST
Parameters:
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).
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Description: Required. The parent (project and location) where the Memberships will be created. Specified in the format `projects/*/locations/*`.
Required: Yes
Type: string
membershipId
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.
Location: query
Type: string
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/memberships
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
Parameter Order: parent
▼ ▲ gkehub.projects.locations.memberships.patch
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}
Parameters:
name
Description: Required. The Membership resource name in the format `projects/*/locations/*/memberships/*`.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/memberships/[^/]+$
Location: path
Type: string
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).
updateMask
Format: google-fieldmask
Description: Required. Mask of fields to update.
Type: string
Location: query
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates an existing Membership.
Parameter Order: name
HTTP Method: PATCH
Path: v1beta/{+name}
▼ ▲ gkehub.projects.locations.memberships.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
HTTP Method: DELETE
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/memberships/[^/]+$
Required: Yes
Location: path
Description: Required. The Membership resource name in the format `projects/*/locations/*/memberships/*`.
force
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.
Type: boolean
Location: query
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).
Location: query
Type: string
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}
Parameter Order: name
Path: v1beta/{+name}
▼ ▲ gkehub.projects.locations.memberships.get
Parameter Order: name
HTTP Method: GET
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}
Path: v1beta/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/memberships/[^/]+$
Description: Required. The Membership resource name in the format `projects/*/locations/*/memberships/*`.
Type: string
Description: Gets the details of a Membership.
▼ ▲ gkehub.projects.locations.memberships.list
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/memberships
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
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.
pageSize
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.
Type: integer
Format: int32
Location: query
filter
Type: string
Location: query
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
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
Required: Yes
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.
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Path: v1beta/{+parent}/memberships
Parameter Order: parent
Description: Lists Memberships in a given project and location.