Reference documentation and code samples for the Compute V1 Client class SetBackupTargetPoolRequest.
A request message for TargetPools.SetBackup. See the method description for details.
Generated from protobuf message google.cloud.compute.v1.SetBackupTargetPoolRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ failover_ratio |
float
New failoverRatio value for the target pool. |
↳ project |
string
Project ID for this request. |
↳ region |
string
Name of the region scoping this request. |
↳ request_id |
string
An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 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 original operation with the same request ID was received, and if so, will ignore 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). |
↳ target_pool |
string
Name of the TargetPool resource to set a backup pool for. |
↳ target_reference_resource |
Google\Cloud\Compute\V1\TargetReference
The body resource for this request |
getFailoverRatio
New failoverRatio value for the target pool.
Generated from protobuf field optional float failover_ratio = 212667006;
| Returns | |
|---|---|
| Type | Description |
float | |
hasFailoverRatio
clearFailoverRatio
setFailoverRatio
New failoverRatio value for the target pool.
Generated from protobuf field optional float failover_ratio = 212667006;
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProject
Project ID for this request.
Generated from protobuf field string project = 227560217 [(.google.api.field_behavior) = REQUIRED, (.google.cloud.operation_request_field) = "project"];
| Returns | |
|---|---|
| Type | Description |
string | |
setProject
Project ID for this request.
Generated from protobuf field string project = 227560217 [(.google.api.field_behavior) = REQUIRED, (.google.cloud.operation_request_field) = "project"];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRegion
Name of the region scoping this request.
Generated from protobuf field string region = 138946292 [(.google.api.field_behavior) = REQUIRED, (.google.cloud.operation_request_field) = "region"];
| Returns | |
|---|---|
| Type | Description |
string | |
setRegion
Name of the region scoping this request.
Generated from protobuf field string region = 138946292 [(.google.api.field_behavior) = REQUIRED, (.google.cloud.operation_request_field) = "region"];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRequestId
An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 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 original operation with the same request ID was received, and if so, will ignore 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).
Generated from protobuf field optional string request_id = 37109963;
| Returns | |
|---|---|
| Type | Description |
string | |
hasRequestId
clearRequestId
setRequestId
An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 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 original operation with the same request ID was received, and if so, will ignore 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).
Generated from protobuf field optional string request_id = 37109963;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTargetPool
Name of the TargetPool resource to set a backup pool for.
Generated from protobuf field string target_pool = 62796298 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setTargetPool
Name of the TargetPool resource to set a backup pool for.
Generated from protobuf field string target_pool = 62796298 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTargetReferenceResource
The body resource for this request
Generated from protobuf field .google.cloud.compute.v1.TargetReference target_reference_resource = 523721712 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\TargetReference|null | |
hasTargetReferenceResource
clearTargetReferenceResource
setTargetReferenceResource
The body resource for this request
Generated from protobuf field .google.cloud.compute.v1.TargetReference target_reference_resource = 523721712 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Compute\V1\TargetReference
|
| Returns | |
|---|---|
| Type | Description |
$this | |