Google Cloud Gke Hub V1 Client - Class KubernetesResource (0.8.2)

Reference documentation and code samples for the Google Cloud Gke Hub V1 Client class 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.

Generated from protobuf message google.cloud.gkehub.v1.KubernetesResource

Namespace

Google \ Cloud \ GkeHub \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ membership_cr_manifest 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.

↳ membership_resources array<Google\Cloud\GkeHub\V1\ResourceManifest>

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.

↳ connect_resources array<Google\Cloud\GkeHub\V1\ResourceManifest>

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.

↳ resource_options Google\Cloud\GkeHub\V1\ResourceOptions

Optional. Options for Kubernetes resource generation.

getMembershipCrManifest

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.

Returns
TypeDescription
string

setMembershipCrManifest

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getMembershipResources

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.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setMembershipResources

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.

Parameter
NameDescription
var array<Google\Cloud\GkeHub\V1\ResourceManifest>
Returns
TypeDescription
$this

getConnectResources

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.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setConnectResources

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.

Parameter
NameDescription
var array<Google\Cloud\GkeHub\V1\ResourceManifest>
Returns
TypeDescription
$this

getResourceOptions

Optional. Options for Kubernetes resource generation.

Returns
TypeDescription
Google\Cloud\GkeHub\V1\ResourceOptions|null

hasResourceOptions

clearResourceOptions

setResourceOptions

Optional. Options for Kubernetes resource generation.

Parameter
NameDescription
var Google\Cloud\GkeHub\V1\ResourceOptions
Returns
TypeDescription
$this