Types for Google Cloud Gkehub v1 API¶
- class google.cloud.gkehub_v1.types.Authority(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAuthority 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
- issuer¶
Optional. A JSON Web Token (JWT) issuer URI.
issuermust start withhttps://and be a valid URL with length <2000 characters.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
issuerdisables Workload Identity.issuercannot be directly modified; it must be cleared (and Workload Identity disabled) before using a new issuer (and re-enabling Workload Identity).- Type
- workload_identity_pool¶
Output only. The name of the workload identity pool in which
issuerwill 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.- Type
- identity_provider¶
Output only. An identity provider that reflects the
issuerin the workload identity pool.- Type
- class google.cloud.gkehub_v1.types.CommonFeatureSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCommonFeatureSpec contains Hub-wide configuration information
- class google.cloud.gkehub_v1.types.CommonFeatureState(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCommonFeatureState contains Hub-wide Feature status information.
- state¶
Output only. The “running state” of the Feature in this Hub.
- class google.cloud.gkehub_v1.types.ConnectAgentResource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConnectAgentResource represents a Kubernetes resource manifest for Connect Agent deployment.
- type_¶
Kubernetes type of the resource.
- class google.cloud.gkehub_v1.types.CreateFeatureRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for the
GkeHub.CreateFeaturemethod.- parent¶
Required. The parent (project and location) where the Feature will be created. Specified in the format
projects/*/locations/*.- Type
- resource¶
The Feature resource to create.
- request_id¶
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
- class google.cloud.gkehub_v1.types.CreateMembershipRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for the
GkeHub.CreateMembershipmethod.- parent¶
Required. The parent (project and location) where the Memberships will be created. Specified in the format
projects/*/locations/*.- Type
- membership_id¶
Required. Client chosen ID for the membership.
membership_idmust be a valid RFC 1123 compliant DNS label:At most 63 characters in length
It must consist of lower case alphanumeric characters or
-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.- Type
- resource¶
Required. The membership to create.
- request_id¶
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
- class google.cloud.gkehub_v1.types.DeleteFeatureRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
GkeHub.DeleteFeaturemethod.- force¶
If set to true, the delete will ignore any outstanding resources for this Feature (that is,
FeatureState.has_resourcesis set to true). These resources will NOT be cleaned up or modified in any way.- Type
- request_id¶
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
- class google.cloud.gkehub_v1.types.DeleteMembershipRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
GkeHub.DeleteMembershipmethod.- name¶
Required. The Membership resource name in the format
projects/*/locations/*/memberships/*.- Type
- request_id¶
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
- class google.cloud.gkehub_v1.types.Feature(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageFeature represents the settings and status of any Hub Feature.
- name¶
Output only. The full, unique name of this Feature resource in the format
projects/*/locations/*/features/*.- Type
- resource_state¶
Output only. State of the Feature resource itself.
- spec¶
Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused.
- membership_specs¶
Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused.
The keys indicate which Membership the configuration is for, in the form:
projects/{p}/locations/{l}/memberships/{m}
Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature’s project.
{p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature.
- Type
MutableMapping[str, google.cloud.gkehub_v1.types.MembershipFeatureSpec]
- state¶
Output only. The Hub-wide Feature state.
- membership_states¶
Output only. Membership-specific Feature status. If this Feature does report any per-Membership status, this field may be unused.
The keys indicate which Membership the state is for, in the form:
projects/{p}/locations/{l}/memberships/{m}
Where {p} is the project number, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} MUST match the Feature’s project number.
- Type
MutableMapping[str, google.cloud.gkehub_v1.types.MembershipFeatureState]
- create_time¶
Output only. When the Feature resource was created.
- update_time¶
Output only. When the Feature resource was last updated.
- delete_time¶
Output only. When the Feature resource was deleted.
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class MembershipSpecsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class MembershipStatesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.gkehub_v1.types.FeatureResourceState(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageFeatureResourceState describes the state of a Feature resource in the GkeHub API. See
FeatureStatefor the “running state” of the Feature in the Hub and across Memberships.- state¶
The current state of the Feature resource in the Hub API.
- class State(value)[source]¶
Bases:
proto.enums.EnumState describes the lifecycle status of a Feature.
- Values:
- STATE_UNSPECIFIED (0):
State is unknown or not set.
- ENABLING (1):
The Feature is being enabled, and the Feature resource is being created. Once complete, the corresponding Feature will be enabled in this Hub.
- ACTIVE (2):
The Feature is enabled in this Hub, and the Feature resource is fully available.
- DISABLING (3):
The Feature is being disabled in this Hub, and the Feature resource is being deleted.
- UPDATING (4):
The Feature resource is being updated.
- SERVICE_UPDATING (5):
The Feature resource is being updated by the Hub Service.
- class google.cloud.gkehub_v1.types.FeatureState(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageFeatureState describes the high-level state of a Feature. It may be used to describe a Feature’s state at the environ-level, or per-membershop, depending on the context.
- code¶
The high-level, machine-readable status of this Feature.
- update_time¶
The time this status and any related Feature-specific details were updated.
- class Code(value)[source]¶
Bases:
proto.enums.EnumCode represents a machine-readable, high-level status of the Feature.
- Values:
- CODE_UNSPECIFIED (0):
Unknown or not set.
- OK (1):
The Feature is operating normally.
- WARNING (2):
The Feature has encountered an issue, and is operating in a degraded state. The Feature may need intervention to return to normal operation. See the description and any associated Feature-specific details for more information.
- ERROR (3):
The Feature is not operating or is in a severely degraded state. The Feature may need intervention to return to normal operation. See the description and any associated Feature-specific details for more information.
- class google.cloud.gkehub_v1.types.GenerateConnectManifestRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
GkeHub.GenerateConnectManifestmethod. .- name¶
Required. The Membership resource name the Agent will associate with, in the format
projects/*/locations/*/memberships/*.- Type
- namespace¶
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
- proxy¶
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.- Type
- is_upgrade¶
Optional. If true, generate the resources for upgrade only. Some resources generated only for installation (e.g. secrets) will be excluded.
- Type
- registry¶
Optional. The registry to fetch the connect agent image from. Defaults to gcr.io/gkeconnect.
- Type
- class google.cloud.gkehub_v1.types.GenerateConnectManifestResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageGenerateConnectManifestResponse contains manifest information for installing/upgrading a Connect agent.
- manifest¶
The ordered list of Kubernetes resources that need to be applied to the cluster for GKE Connect agent installation/upgrade.
- Type
MutableSequence[google.cloud.gkehub_v1.types.ConnectAgentResource]
- class google.cloud.gkehub_v1.types.GetFeatureRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
GkeHub.GetFeaturemethod.
- class google.cloud.gkehub_v1.types.GetMembershipRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
GkeHub.GetMembershipmethod.
- class google.cloud.gkehub_v1.types.GkeCluster(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageGkeCluster contains information specific to GKE clusters.
- resource_link¶
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.
- Type
- class google.cloud.gkehub_v1.types.KubernetesMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageKubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters.
- kubernetes_api_server_version¶
Output only. Kubernetes API server version string as reported by
/version.- Type
- node_provider_id¶
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.
- Type
- memory_mb¶
Output only. The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB.
- Type
- update_time¶
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.
- class google.cloud.gkehub_v1.types.KubernetesResource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageKubernetesResource 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.
- membership_cr_manifest¶
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.
- Type
- membership_resources¶
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.
- Type
MutableSequence[google.cloud.gkehub_v1.types.ResourceManifest]
- connect_resources¶
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.
- Type
MutableSequence[google.cloud.gkehub_v1.types.ResourceManifest]
- resource_options¶
Optional. Options for Kubernetes resource generation.
- class google.cloud.gkehub_v1.types.ListFeaturesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
GkeHub.ListFeaturesmethod.- parent¶
Required. The parent (project and location) where the Features will be listed. Specified in the format
projects/*/locations/*.- Type
- page_size¶
When requesting a ‘page’ of resources,
page_sizespecifies number of resources to return. If unspecified or set to 0, all resources will be returned.- Type
- page_token¶
Token returned by previous call to
ListFeatureswhich specifies the position in the list from where to continue listing the resources.- Type
- filter¶
Lists Features that match the filter expression, following the syntax outlined in https://google.aip.dev/160.
Examples:
Feature with the name “servicemesh” in project “foo-proj”:
name = “projects/foo-proj/locations/global/features/servicemesh”
Features that have a label called
foo:labels.foo:*
Features that have a label called
foowhose value isbar:labels.foo = bar
- Type
- order_by¶
One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.
- Type
- class google.cloud.gkehub_v1.types.ListFeaturesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for the
GkeHub.ListFeaturesmethod.- resources¶
The list of matching Features
- Type
MutableSequence[google.cloud.gkehub_v1.types.Feature]
- class google.cloud.gkehub_v1.types.ListMembershipsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
GkeHub.ListMembershipsmethod.- parent¶
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
- page_size¶
Optional. When requesting a ‘page’ of resources,
page_sizespecifies number of resources to return. If unspecified or set to 0, all resources will be returned.- Type
- page_token¶
Optional. Token returned by previous call to
ListMembershipswhich specifies the position in the list from where to continue listing the resources.- Type
- filter¶
Optional. Lists Memberships that match the filter expression, following the syntax outlined in https://google.aip.dev/160.
Examples:
Name is
barin projectfoo-projand locationglobal:name = “projects/foo-proj/locations/global/membership/bar”
Memberships that have a label called
foo:labels.foo:*
Memberships that have a label called
foowhose value isbar:labels.foo = bar
Memberships in the CREATING state:
state = CREATING
- Type
- order_by¶
Optional. One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.
- Type
- class google.cloud.gkehub_v1.types.ListMembershipsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for the
GkeHub.ListMembershipsmethod.- resources¶
The list of matching Memberships.
- Type
MutableSequence[google.cloud.gkehub_v1.types.Membership]
- next_page_token¶
A token to request the next page of resources from the
ListMembershipsmethod. The value of an empty string means that there are no more resources to return.- Type
- class google.cloud.gkehub_v1.types.Membership(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMembership contains information about a member cluster.
- endpoint¶
Optional. Endpoint information to reach this member.
This field is a member of oneof
type.
- name¶
Output only. The full, unique name of this Membership resource in the format
projects/*/locations/*/memberships/{membership_id}, set during creation.membership_idmust be a valid RFC 1123 compliant DNS label:At most 63 characters in length
It must consist of lower case alphanumeric characters or
-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.- Type
- description¶
Output only. Description of this membership, limited to 63 characters. Must match the regex:
[a-zA-Z0-9][a-zA-Z0-9_\-\.\ ]*This field is present for legacy purposes.
- Type
- state¶
Output only. State of the Membership resource.
- create_time¶
Output only. When the Membership was created.
- update_time¶
Output only. When the Membership was last updated.
- delete_time¶
Output only. When the Membership was deleted.
- external_id¶
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][a-zA-Z0-9_\-\.]*If this Membership represents a Kubernetes cluster, this value should be set to the UID of the
kube-systemnamespace object.- Type
- last_connection_time¶
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.
- unique_id¶
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.
- Type
- authority¶
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
- monitoring_config¶
Optional. The monitoring config information for this membership.
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.gkehub_v1.types.MembershipEndpoint(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMembershipEndpoint contains information needed to contact a Kubernetes API, endpoint and any additional Kubernetes metadata.
- gke_cluster¶
Optional. GKE-specific information. Only present if this Membership is a GKE cluster.
- kubernetes_metadata¶
Output only. Useful Kubernetes-specific metadata.
- kubernetes_resource¶
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.
- class google.cloud.gkehub_v1.types.MembershipFeatureSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMembershipFeatureSpec contains configuration information for a single Membership.
- class google.cloud.gkehub_v1.types.MembershipFeatureState(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMembershipFeatureState contains Feature status information for a single Membership.
- configmanagement¶
Config Management-specific state.
This field is a member of oneof
feature_state.- Type
google.cloud.gkehub_v1.configmanagement_v1.MembershipState
- state¶
The high-level state of this Feature for a single membership.
- class google.cloud.gkehub_v1.types.MembershipState(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMembershipState describes the state of a Membership resource.
- code¶
Output only. The current state of the Membership resource.
- class Code(value)[source]¶
Bases:
proto.enums.EnumCode describes the state of a Membership resource.
- Values:
- CODE_UNSPECIFIED (0):
The code is not set.
- CREATING (1):
The cluster is being registered.
- READY (2):
The cluster is registered.
- DELETING (3):
The cluster is being unregistered.
- UPDATING (4):
The Membership is being updated.
- SERVICE_UPDATING (5):
The Membership is being updated by the Hub Service.
- class google.cloud.gkehub_v1.types.MonitoringConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThis field informs Fleet-based applications/services/UIs with the necessary information for where each underlying Cluster reports its metrics.
- cluster¶
Immutable. Cluster name used to report metrics. For Anthos on VMWare/Baremetal, it would be in format
memberClusters/cluster_name; And for Anthos on MultiCloud, it would be in format{azureClusters, awsClusters}/cluster_name.- Type
- kubernetes_metrics_prefix¶
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
- Type
- class google.cloud.gkehub_v1.types.OperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents the metadata of the long-running operation.
- create_time¶
Output only. The time the operation was created.
- end_time¶
Output only. The time the operation finished running.
- cancel_requested¶
Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
Code.CANCELLED.- Type
- class google.cloud.gkehub_v1.types.ResourceManifest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResourceManifest represents a single Kubernetes resource to be applied to the cluster.
- class google.cloud.gkehub_v1.types.ResourceOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResourceOptions represent options for Kubernetes resource generation.
- connect_version¶
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.
- Type
- v1beta1_crd¶
Optional. Use
apiextensions/v1beta1instead ofapiextensions/v1for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16.- Type
- class google.cloud.gkehub_v1.types.TypeMeta(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageTypeMeta is the type information needed for content unmarshalling of Kubernetes resources in the manifest.
- class google.cloud.gkehub_v1.types.UpdateFeatureRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
GkeHub.UpdateFeaturemethod.- update_mask¶
Mask of fields to update.
- resource¶
Only fields specified in update_mask are updated. If you specify a field in the update_mask but don’t specify its value here that field will be deleted. If you are updating a map field, set the value of a key to null or empty string to delete the key from the map. It’s not possible to update a key’s value to the empty string. If you specify the update_mask to be a special path “*”, fully replaces all user-modifiable fields to match
resource.
- request_id¶
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
- class google.cloud.gkehub_v1.types.UpdateMembershipRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
GkeHub.UpdateMembershipmethod.- name¶
Required. The Membership resource name in the format
projects/*/locations/*/memberships/*.- Type
- update_mask¶
Required. Mask of fields to update.
- resource¶
Required. Only fields specified in update_mask are updated. If you specify a field in the update_mask but don’t specify its value here that field will be deleted. If you are updating a map field, set the value of a key to null or empty string to delete the key from the map. It’s not possible to update a key’s value to the empty string. If you specify the update_mask to be a special path “*”, fully replaces all user-modifiable fields to match
resource.
- request_id¶
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
