Google Cloud Redis Cluster V1 Client - Class RescheduleClusterMaintenanceRequest (0.4.0)

Reference documentation and code samples for the Google Cloud Redis Cluster V1 Client class RescheduleClusterMaintenanceRequest.

Request for rescheduling a cluster maintenance.

Generated from protobuf message google.cloud.redis.cluster.v1.RescheduleClusterMaintenanceRequest

Namespace

Google \ Cloud \ Redis \ Cluster \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Required. Redis Cluster instance resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a GCP region.
`↳ reschedule_type`	`int` Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.
`↳ schedule_time`	`Google\Protobuf\Timestamp` Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for example `2012-11-15T16:19:00.094Z`.

getName

Required. Redis Cluster instance resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

Returns
Type	Description
`string`

setName

Required. Redis Cluster instance resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getRescheduleType

Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.

Returns
Type	Description
`int`

setRescheduleType

Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getScheduleTime

Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasScheduleTime

clearScheduleTime

setScheduleTime

Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

static::build

Parameters
Name	Description
`name`	`string` Required. Redis Cluster instance resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a GCP region. Please see CloudRedisClusterClient::clusterName() for help formatting this field.
`rescheduleType`	`int` Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well. For allowed values, use constants defined on RescheduleClusterMaintenanceRequest\RescheduleType
`scheduleTime`	`Google\Protobuf\Timestamp` Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for example `2012-11-15T16:19:00.094Z`.

Returns
Type	Description
`RescheduleClusterMaintenanceRequest`