Reference documentation and code samples for the Google Cloud Container V1 Client class SetMaintenancePolicyRequest.
SetMaintenancePolicyRequest sets the maintenance policy for a cluster.
Generated from protobuf message google.container.v1.SetMaintenancePolicyRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ project_id |
string
Required. The Google Developers Console project ID or project number. |
↳ zone |
string
Required. The name of the Google Compute Engine zone in which the cluster resides. |
↳ cluster_id |
string
Required. The name of the cluster to update. |
↳ maintenance_policy |
Google\Cloud\Container\V1\MaintenancePolicy
Required. The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy. |
↳ name |
string
The name (project, location, cluster name) of the cluster to set maintenance policy. Specified in the format |
getProjectId
Required. The Google Developers Console project ID or project number.
Generated from protobuf field string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setProjectId
Required. The Google Developers Console project ID or project number.
Generated from protobuf field string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getZone
Required. The name of the Google Compute Engine zone in which the cluster resides.
Generated from protobuf field string zone = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setZone
Required. The name of the Google Compute Engine zone in which the cluster resides.
Generated from protobuf field string zone = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getClusterId
Required. The name of the cluster to update.
Generated from protobuf field string cluster_id = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setClusterId
Required. The name of the cluster to update.
Generated from protobuf field string cluster_id = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMaintenancePolicy
Required. The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy.
Generated from protobuf field .google.container.v1.MaintenancePolicy maintenance_policy = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Container\V1\MaintenancePolicy|null | |
hasMaintenancePolicy
clearMaintenancePolicy
setMaintenancePolicy
Required. The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy.
Generated from protobuf field .google.container.v1.MaintenancePolicy maintenance_policy = 4 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Container\V1\MaintenancePolicy
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getName
The name (project, location, cluster name) of the cluster to set maintenance policy.
Specified in the format projects/*/locations/*/clusters/*.
Generated from protobuf field string name = 5;
| Returns | |
|---|---|
| Type | Description |
string | |
setName
The name (project, location, cluster name) of the cluster to set maintenance policy.
Specified in the format projects/*/locations/*/clusters/*.
Generated from protobuf field string name = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |