list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists Scopes.
+
+ listMemberships(scopeName, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists Memberships bound to a Scope. The response includes relevant Memberships from all regions.
+ +Retrieves the next page of results.
listPermitted(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists permitted Scopes.
@@ -336,6 +342,127 @@listMemberships(scopeName, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists Memberships bound to a Scope. The response includes relevant Memberships from all regions.
+
+Args:
+ scopeName: string, Required. Name of the Scope, in the format `projects/*/locations/global/scopes/*`, to which the Memberships are bound. (required)
+ filter: string, Optional. Lists Memberships that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Currently, filtering can be done only based on Memberships's `name`, `labels`, `create_time`, `update_time`, and `unique_id`.
+ pageSize: integer, 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. Pagination is currently not supported; therefore, setting this field does not have any impact for now.
+ pageToken: string, Optional. Token returned by previous call to `ListBoundMemberships` which specifies the position in the list from where to continue listing the resources.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # List of Memberships bound to a Scope.
+ "memberships": [ # The list of Memberships bound to the given Scope.
+ { # Membership contains information about a member cluster.
+ "authority": { # Authority encodes how Google will recognize identities from this Membership. See the workload identity documentation for more details: https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity # Optional. How to identify workloads from this Membership. See the documentation on Workload Identity for more details: https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity
+ "identityProvider": "A String", # Output only. An identity provider that reflects the `issuer` in the workload identity pool.
+ "issuer": "A String", # Optional. A JSON Web Token (JWT) issuer URI. `issuer` must start with `https://` and be a valid URL with length <2000 characters, it must use `location` rather than `zone` for GKE clusters. If set, then Google will allow valid OIDC tokens from this issuer to authenticate within the workload_identity_pool. OIDC discovery will be performed on this URI to validate tokens from the issuer. Clearing `issuer` disables Workload Identity. `issuer` cannot be directly modified; it must be cleared (and Workload Identity disabled) before using a new issuer (and re-enabling Workload Identity).
+ "oidcJwks": "A String", # Optional. OIDC verification keys for this Membership in JWKS format (RFC 7517). When this field is set, OIDC discovery will NOT be performed on `issuer`, and instead OIDC tokens will be validated using this field.
+ "workloadIdentityPool": "A String", # Output only. The name of the workload identity pool in which `issuer` will be recognized. There is a single Workload Identity Pool per Hub that is shared between all Memberships that belong to that Hub. For a Hub hosted in {PROJECT_ID}, the workload pool format is `{PROJECT_ID}.hub.id.goog`, although this is subject to change in newer versions of this API.
+ },
+ "createTime": "A String", # Output only. When the Membership was created.
+ "deleteTime": "A String", # Output only. When the Membership was deleted.
+ "description": "A String", # Output only. Description of this membership, limited to 63 characters. Must match the regex: `a-zA-Z0-9*` This field is present for legacy purposes.
+ "endpoint": { # MembershipEndpoint contains information needed to contact a Kubernetes API, endpoint and any additional Kubernetes metadata. # Optional. Endpoint information to reach this member.
+ "applianceCluster": { # ApplianceCluster contains information specific to GDC Edge Appliance Clusters. # Optional. Specific information for a GDC Edge Appliance cluster.
+ "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the Appliance Cluster. For example: //transferappliance.googleapis.com/projects/my-project/locations/us-west1-a/appliances/my-appliance
+ },
+ "edgeCluster": { # EdgeCluster contains information specific to Google Edge Clusters. # Optional. Specific information for a Google Edge cluster.
+ "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster
+ },
+ "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE-on-GCP cluster.
+ "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane.
+ "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported.
+ },
+ "googleManaged": True or False, # Output only. Whether the lifecycle of this membership is managed by a google cluster platform service.
+ "kubernetesMetadata": { # KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters. # Output only. Useful Kubernetes-specific metadata.
+ "kubernetesApiServerVersion": "A String", # Output only. Kubernetes API server version string as reported by `/version`.
+ "memoryMb": 42, # Output only. The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB.
+ "nodeCount": 42, # Output only. Node count as reported by Kubernetes nodes resources.
+ "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty.
+ "updateTime": "A String", # Output only. The time at which these details were last updated. This update_time is different from the Membership-level update_time since EndpointDetails are updated internally for API consumers.
+ "vcpuCount": 42, # Output only. vCPU count as reported by Kubernetes nodes resources.
+ },
+ "kubernetesResource": { # KubernetesResource contains the YAML manifests and configuration for Membership Kubernetes resources in the cluster. After CreateMembership or UpdateMembership, these resources should be re-applied in the cluster. # Optional. The in-cluster Kubernetes Resources that should be applied for a correctly registered cluster, in the steady state. These resources: * Ensure that the cluster is exclusively registered to one and only one Hub Membership. * Propagate Workload Pool Information available in the Membership Authority field. * Ensure proper initial configuration of default Hub Features.
+ "connectResources": [ # Output only. The Kubernetes resources for installing the GKE Connect agent This field is only populated in the Membership returned from a successful long-running operation from CreateMembership or UpdateMembership. It is not populated during normal GetMembership or ListMemberships requests. To get the resource manifest after the initial registration, the caller should make a UpdateMembership call with an empty field mask.
+ { # ResourceManifest represents a single Kubernetes resource to be applied to the cluster.
+ "clusterScoped": True or False, # Whether the resource provided in the manifest is `cluster_scoped`. If unset, the manifest is assumed to be namespace scoped. This field is used for REST mapping when applying the resource in a cluster.
+ "manifest": "A String", # YAML manifest of the resource.
+ },
+ ],
+ "membershipCrManifest": "A String", # Input only. The YAML representation of the Membership CR. This field is ignored for GKE clusters where Hub can read the CR directly. Callers should provide the CR that is currently present in the cluster during CreateMembership or UpdateMembership, or leave this field empty if none exists. The CR manifest is used to validate the cluster has not been registered with another Membership.
+ "membershipResources": [ # Output only. Additional Kubernetes resources that need to be applied to the cluster after Membership creation, and after every update. This field is only populated in the Membership returned from a successful long-running operation from CreateMembership or UpdateMembership. It is not populated during normal GetMembership or ListMemberships requests. To get the resource manifest after the initial registration, the caller should make a UpdateMembership call with an empty field mask.
+ { # ResourceManifest represents a single Kubernetes resource to be applied to the cluster.
+ "clusterScoped": True or False, # Whether the resource provided in the manifest is `cluster_scoped`. If unset, the manifest is assumed to be namespace scoped. This field is used for REST mapping when applying the resource in a cluster.
+ "manifest": "A String", # YAML manifest of the resource.
+ },
+ ],
+ "resourceOptions": { # ResourceOptions represent options for Kubernetes resource generation. # Optional. Options for Kubernetes resource generation.
+ "connectVersion": "A String", # Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected.
+ "k8sVersion": "A String", # Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`.
+ "v1beta1Crd": True or False, # Optional. Use `apiextensions/v1beta1` instead of `apiextensions/v1` for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16.
+ },
+ },
+ "multiCloudCluster": { # MultiCloudCluster contains information specific to GKE Multi-Cloud clusters. # Optional. Specific information for a GKE Multi-Cloud cluster.
+ "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that API(gkemulticloud.googleapis.com) resource for this GKE Multi-Cloud cluster no longer exists.
+ "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE Multi-Cloud cluster. For example: //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/awsClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/azureClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/attachedClusters/my-cluster
+ },
+ "onPremCluster": { # OnPremCluster contains information specific to GKE On-Prem clusters. # Optional. Specific information for a GKE On-Prem cluster. An onprem user-cluster who has no resourceLink is not allowed to use this field, it should have a nil "type" instead.
+ "adminCluster": True or False, # Immutable. Whether the cluster is an admin cluster.
+ "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that API(gkeonprem.googleapis.com) resource for this GKE On-Prem cluster no longer exists.
+ "clusterType": "A String", # Immutable. The on prem cluster's type.
+ "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE On-Prem cluster. For example: //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/vmwareClusters/my-cluster //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/bareMetalClusters/my-cluster
+ },
+ },
+ "externalId": "A String", # Optional. An externally-generated and managed ID for this Membership. This ID may be modified after creation, but this is not recommended. The ID must match the regex: `a-zA-Z0-9*` If this Membership represents a Kubernetes cluster, this value should be set to the UID of the `kube-system` namespace object.
+ "labels": { # Optional. Labels for this membership.
+ "a_key": "A String",
+ },
+ "lastConnectionTime": "A String", # Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset.
+ "monitoringConfig": { # MonitoringConfig informs Fleet-based applications/services/UIs how the metrics for the underlying cluster is reported to cloud monitoring services. It can be set from empty to non-empty, but can't be mutated directly to prevent accidentally breaking the constinousty of metrics. # Optional. The monitoring config information for this membership.
+ "cluster": "A String", # Optional. Cluster name used to report metrics. For Anthos on VMWare/Baremetal/MultiCloud clusters, it would be in format {cluster_type}/{cluster_name}, e.g., "awsClusters/cluster_1".
+ "clusterHash": "A String", # Optional. For GKE and Multicloud clusters, this is the UUID of the cluster resource. For VMWare and Baremetal clusters, this is the kube-system UID.
+ "kubernetesMetricsPrefix": "A String", # Optional. Kubernetes system metrics, if available, are written to this prefix. This defaults to kubernetes.io for GKE, and kubernetes.io/anthos for Anthos eventually. Noted: Anthos MultiCloud will have kubernetes.io prefix today but will migration to be under kubernetes.io/anthos.
+ "location": "A String", # Optional. Location used to report Metrics
+ "projectId": "A String", # Optional. Project used to report Metrics
+ },
+ "name": "A String", # Output only. The full, unique name of this Membership resource in the format `projects/*/locations/*/memberships/{membership_id}`, set during creation. `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.
+ "state": { # MembershipState describes the state of a Membership resource. # Output only. State of the Membership resource.
+ "code": "A String", # Output only. The current state of the Membership resource.
+ },
+ "uniqueId": "A String", # Output only. Google-generated UUID for this resource. This is unique across all Membership resources. If a Membership resource is deleted and another resource with the same name is created, it gets a different unique_id.
+ "updateTime": "A String", # Output only. When the Membership was last updated.
+ },
+ ],
+ "nextPageToken": "A String", # A token to request the next page of resources from the `ListBoundMemberships` method. The value of an empty string means that there are no more resources to return.
+ "unreachable": [ # List of locations that could not be reached while fetching this list.
+ "A String",
+ ],
+}
+listMemberships_next()
+ Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
listPermitted(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists permitted Scopes.
diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1.json b/googleapiclient/discovery_cache/documents/gkehub.v1.json
index c7bb47d6789..0e415147892 100644
--- a/googleapiclient/discovery_cache/documents/gkehub.v1.json
+++ b/googleapiclient/discovery_cache/documents/gkehub.v1.json
@@ -1834,7 +1834,7 @@
}
}
},
-"revision": "20240216",
+"revision": "20240225",
"rootUrl": "https://gkehub.googleapis.com/",
"schemas": {
"AppDevExperienceFeatureSpec": {
diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json
index 7b7320bd88a..21186fd5c7c 100644
--- a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json
+++ b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json
@@ -1685,6 +1685,47 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
+"listMemberships": {
+"description": "Lists Memberships bound to a Scope. The response includes relevant Memberships from all regions.",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}:listMemberships",
+"httpMethod": "GET",
+"id": "gkehub.projects.locations.scopes.listMemberships",
+"parameterOrder": [
+"scopeName"
+],
+"parameters": {
+"filter": {
+"description": "Optional. Lists Memberships that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Currently, filtering can be done only based on Memberships's `name`, `labels`, `create_time`, `update_time`, and `unique_id`.",
+"location": "query",
+"type": "string"
+},
+"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. Pagination is currently not supported; therefore, setting this field does not have any impact for now.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. Token returned by previous call to `ListBoundMemberships` which specifies the position in the list from where to continue listing the resources.",
+"location": "query",
+"type": "string"
+},
+"scopeName": {
+"description": "Required. Name of the Scope, in the format `projects/*/locations/global/scopes/*`, to which the Memberships are bound.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/scopes/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1alpha/{+scopeName}:listMemberships",
+"response": {
+"$ref": "ListBoundMembershipsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
"listPermitted": {
"description": "Lists permitted Scopes.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/scopes:listPermitted",
@@ -2134,7 +2175,7 @@
}
}
},
-"revision": "20240216",
+"revision": "20240225",
"rootUrl": "https://gkehub.googleapis.com/",
"schemas": {
"AnthosObservabilityFeatureSpec": {
@@ -4536,6 +4577,31 @@
},
"type": "object"
},
+"ListBoundMembershipsResponse": {
+"description": "List of Memberships bound to a Scope.",
+"id": "ListBoundMembershipsResponse",
+"properties": {
+"memberships": {
+"description": "The list of Memberships bound to the given Scope.",
+"items": {
+"$ref": "Membership"
+},
+"type": "array"
+},
+"nextPageToken": {
+"description": "A token to request the next page of resources from the `ListBoundMemberships` method. The value of an empty string means that there are no more resources to return.",
+"type": "string"
+},
+"unreachable": {
+"description": "List of locations that could not be reached while fetching this list.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
"ListFeaturesResponse": {
"description": "Response message for the `GkeHub.ListFeatures` method.",
"id": "ListFeaturesResponse",
diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1alpha2.json b/googleapiclient/discovery_cache/documents/gkehub.v1alpha2.json
index 072ec6e08f2..35c41023227 100644
--- a/googleapiclient/discovery_cache/documents/gkehub.v1alpha2.json
+++ b/googleapiclient/discovery_cache/documents/gkehub.v1alpha2.json
@@ -657,7 +657,7 @@
}
}
},
-"revision": "20240216",
+"revision": "20240225",
"rootUrl": "https://gkehub.googleapis.com/",
"schemas": {
"ApplianceCluster": {
diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json
index efdaf96e907..0a600c6c17b 100644
--- a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json
@@ -2024,7 +2024,7 @@
}
}
},
-"revision": "20240216",
+"revision": "20240225",
"rootUrl": "https://gkehub.googleapis.com/",
"schemas": {
"AnthosObservabilityFeatureSpec": {
diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json
index 68d446f7733..1e05a1b462f 100644
--- a/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json
@@ -712,7 +712,7 @@
}
}
},
-"revision": "20240216",
+"revision": "20240225",
"rootUrl": "https://gkehub.googleapis.com/",
"schemas": {
"ApplianceCluster": {
diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json
index 939d276ffa6..7b7024918a2 100644
--- a/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json
+++ b/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json
@@ -280,7 +280,7 @@
}
}
},
-"revision": "20240216",
+"revision": "20240225",
"rootUrl": "https://gkehub.googleapis.com/",
"schemas": {
"CancelOperationRequest": {