Google Cloud Gke Hub V1 Client - Class MembershipState (0.7.1)

Reference documentation and code samples for the Google Cloud Gke Hub V1 Client class MembershipState.

Anthos Config Management: State for a single cluster.

Generated from protobuf message google.cloud.gkehub.configmanagement.v1.MembershipState

Namespace

Google \ Cloud \ GkeHub \ ConfigManagement \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ cluster_name string

The user-defined name for the cluster used by ClusterSelectors to group clusters together. This should match Membership's membership_name, unless the user installed ACM on the cluster manually prior to enabling the ACM hub feature. Unique within a Anthos Config Management installation.

↳ membership_spec Google\Cloud\GkeHub\ConfigManagement\V1\MembershipSpec

Membership configuration in the cluster. This represents the actual state in the cluster, while the MembershipSpec in the FeatureSpec represents the intended state

↳ operator_state Google\Cloud\GkeHub\ConfigManagement\V1\OperatorState

Current install status of ACM's Operator

↳ config_sync_state Google\Cloud\GkeHub\ConfigManagement\V1\ConfigSyncState

Current sync status

↳ policy_controller_state Google\Cloud\GkeHub\ConfigManagement\V1\PolicyControllerState

PolicyController status

↳ hierarchy_controller_state Google\Cloud\GkeHub\ConfigManagement\V1\HierarchyControllerState

Hierarchy Controller status

getClusterName

The user-defined name for the cluster used by ClusterSelectors to group clusters together. This should match Membership's membership_name, unless the user installed ACM on the cluster manually prior to enabling the ACM hub feature.

Unique within a Anthos Config Management installation.

Returns
TypeDescription
string

setClusterName

The user-defined name for the cluster used by ClusterSelectors to group clusters together. This should match Membership's membership_name, unless the user installed ACM on the cluster manually prior to enabling the ACM hub feature.

Unique within a Anthos Config Management installation.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getMembershipSpec

Membership configuration in the cluster. This represents the actual state in the cluster, while the MembershipSpec in the FeatureSpec represents the intended state

Returns
TypeDescription
Google\Cloud\GkeHub\ConfigManagement\V1\MembershipSpec|null

hasMembershipSpec

clearMembershipSpec

setMembershipSpec

Membership configuration in the cluster. This represents the actual state in the cluster, while the MembershipSpec in the FeatureSpec represents the intended state

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

getOperatorState

Current install status of ACM's Operator

Returns
TypeDescription
Google\Cloud\GkeHub\ConfigManagement\V1\OperatorState|null

hasOperatorState

clearOperatorState

setOperatorState

Current install status of ACM's Operator

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

getConfigSyncState

Current sync status

Returns
TypeDescription
Google\Cloud\GkeHub\ConfigManagement\V1\ConfigSyncState|null

hasConfigSyncState

clearConfigSyncState

setConfigSyncState

Current sync status

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

getPolicyControllerState

PolicyController status

Returns
TypeDescription
Google\Cloud\GkeHub\ConfigManagement\V1\PolicyControllerState|null

hasPolicyControllerState

clearPolicyControllerState

setPolicyControllerState

PolicyController status

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

getHierarchyControllerState

Hierarchy Controller status

Returns
TypeDescription
Google\Cloud\GkeHub\ConfigManagement\V1\HierarchyControllerState|null

hasHierarchyControllerState

clearHierarchyControllerState

setHierarchyControllerState

Hierarchy Controller status

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