Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class UpgradeClusterRequest.
Upgrades a cluster.
Generated from protobuf message google.cloud.alloydb.v1.UpgradeClusterRequest
Namespace
Google \ Cloud \ AlloyDb \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The resource name of the cluster. |
↳ version |
int
Required. The version the cluster is going to be upgraded to. |
↳ request_id |
string
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
↳ validate_only |
bool
Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. |
↳ etag |
string
Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, upgrade will be blocked and an ABORTED error will be returned. |
getName
Required. The resource name of the cluster.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. The resource name of the cluster.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVersion
Required. The version the cluster is going to be upgraded to.
| Returns | |
|---|---|
| Type | Description |
int |
|
setVersion
Required. The version the cluster is going to be upgraded to.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRequestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
| Returns | |
|---|---|
| Type | Description |
string |
|
setRequestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getValidateOnly
Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setValidateOnly
Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEtag
Optional. The current etag of the Cluster.
If an etag is provided and does not match the current etag of the Cluster, upgrade will be blocked and an ABORTED error will be returned.
| Returns | |
|---|---|
| Type | Description |
string |
|
setEtag
Optional. The current etag of the Cluster.
If an etag is provided and does not match the current etag of the Cluster, upgrade will be blocked and an ABORTED error will be returned.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. The resource name of the cluster. Please see AlloyDBAdminClient::clusterName() for help formatting this field. |
version |
int
Required. The version the cluster is going to be upgraded to. For allowed values, use constants defined on DatabaseVersion |
| Returns | |
|---|---|
| Type | Description |
UpgradeClusterRequest |
|