Google Anthos Multi Cloud V1 Client - Class UpdateAttachedClusterRequest (0.4.4)

Reference documentation and code samples for the Google Anthos Multi Cloud V1 Client class UpdateAttachedClusterRequest.

Request message for AttachedClusters.UpdateAttachedCluster method.

Generated from protobuf message google.cloud.gkemulticloud.v1.UpdateAttachedClusterRequest

Namespace

Google \ Cloud \ GkeMultiCloud \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ attached_cluster Google\Cloud\GkeMultiCloud\V1\AttachedCluster

Required. The AttachedCluster resource to update.

↳ validate_only bool

If set, only validate the request, but do not actually update the cluster.

↳ update_mask Google\Protobuf\FieldMask

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field can only include these fields from AttachedCluster: * description. * annotations. * platform_version. * authorization.admin_users. * logging_config.component_config.enable_components. * monitoring_config.managed_prometheus_config.enabled.

getAttachedCluster

Required. The AttachedCluster resource to update.

Returns
TypeDescription
Google\Cloud\GkeMultiCloud\V1\AttachedCluster|null

hasAttachedCluster

clearAttachedCluster

setAttachedCluster

Required. The AttachedCluster resource to update.

Parameter
NameDescription
var Google\Cloud\GkeMultiCloud\V1\AttachedCluster
Returns
TypeDescription
$this

getValidateOnly

If set, only validate the request, but do not actually update the cluster.

Returns
TypeDescription
bool

setValidateOnly

If set, only validate the request, but do not actually update the cluster.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getUpdateMask

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field can only include these fields from AttachedCluster:

  • description.
  • annotations.
    • platform_version.
    • authorization.admin_users.
    • logging_config.component_config.enable_components.
    • monitoring_config.managed_prometheus_config.enabled.
Returns
TypeDescription
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field can only include these fields from AttachedCluster:

  • description.
  • annotations.
    • platform_version.
    • authorization.admin_users.
    • logging_config.component_config.enable_components.
    • monitoring_config.managed_prometheus_config.enabled.
Parameter
NameDescription
var Google\Protobuf\FieldMask
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
attachedCluster Google\Cloud\GkeMultiCloud\V1\AttachedCluster

Required. The AttachedCluster resource to update.

updateMask Google\Protobuf\FieldMask

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field can only include these fields from AttachedCluster:

  • description.
  • annotations.
  • platform_version.
  • authorization.admin_users.
  • logging_config.component_config.enable_components.
  • monitoring_config.managed_prometheus_config.enabled.
Returns
TypeDescription
Google\Cloud\GkeMultiCloud\V1\UpdateAttachedClusterRequest