Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class protos.google.cloud.compute.v1.SetBackupTargetPoolRequest (3.8.1)

Represents a SetBackupTargetPoolRequest.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.compute.v1.ISetBackupTargetPoolRequest);

Constructs a new SetBackupTargetPoolRequest.

Parameter
Name	Description
`properties`	`google.cloud.compute.v1.ISetBackupTargetPoolRequest` Properties to set

Properties

_failoverRatio

public _failoverRatio?: "failoverRatio";

SetBackupTargetPoolRequest _failoverRatio.

_requestId

public _requestId?: "requestId";

SetBackupTargetPoolRequest _requestId.

failoverRatio

public failoverRatio?: (number|null);

SetBackupTargetPoolRequest failoverRatio.

project

public project: string;

SetBackupTargetPoolRequest project.

region

public region: string;

SetBackupTargetPoolRequest region.

requestId

public requestId?: (string|null);

SetBackupTargetPoolRequest requestId.

targetPool

public targetPool: string;

SetBackupTargetPoolRequest targetPool.

targetReferenceResource

public targetReferenceResource?: (google.cloud.compute.v1.ITargetReference|null);

SetBackupTargetPoolRequest targetReferenceResource.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.ISetBackupTargetPoolRequest): google.cloud.compute.v1.SetBackupTargetPoolRequest;

Creates a new SetBackupTargetPoolRequest instance using the specified properties.

Parameter
Name	Description
`properties`	`google.cloud.compute.v1.ISetBackupTargetPoolRequest` Properties to set

Returns
Type	Description
`google.cloud.compute.v1.SetBackupTargetPoolRequest`	SetBackupTargetPoolRequest instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.compute.v1.SetBackupTargetPoolRequest;

Decodes a SetBackupTargetPoolRequest message from the specified reader or buffer.

Parameters
Name	Description
`reader`	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
`length`	`number` Message length if known beforehand

Returns
Type	Description
`google.cloud.compute.v1.SetBackupTargetPoolRequest`	SetBackupTargetPoolRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.compute.v1.SetBackupTargetPoolRequest;

Decodes a SetBackupTargetPoolRequest message from the specified reader or buffer, length delimited.

Parameter
Name	Description
`reader`	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns
Type	Description
`google.cloud.compute.v1.SetBackupTargetPoolRequest`	SetBackupTargetPoolRequest

encode(message, writer)

public static encode(message: google.cloud.compute.v1.ISetBackupTargetPoolRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified SetBackupTargetPoolRequest message. Does not implicitly messages.

Parameters
Name	Description
`message`	`google.cloud.compute.v1.ISetBackupTargetPoolRequest` SetBackupTargetPoolRequest message or plain object to encode
`writer`	`$protobuf.Writer` Writer to encode to

Returns
Type	Description
`$protobuf.Writer`	Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.compute.v1.ISetBackupTargetPoolRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified SetBackupTargetPoolRequest message, length delimited. Does not implicitly messages.

Parameters
Name	Description
`message`	`google.cloud.compute.v1.ISetBackupTargetPoolRequest` SetBackupTargetPoolRequest message or plain object to encode
`writer`	`$protobuf.Writer` Writer to encode to

Returns
Type	Description
`$protobuf.Writer`	Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.compute.v1.SetBackupTargetPoolRequest;

Creates a SetBackupTargetPoolRequest message from a plain object. Also converts values to their respective internal types.

Parameter
Name	Description
`object`	`{ [k: string]: any }` Plain object

Returns
Type	Description
`google.cloud.compute.v1.SetBackupTargetPoolRequest`	SetBackupTargetPoolRequest

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for SetBackupTargetPoolRequest

Parameter
Name	Description
`typeUrlPrefix`	`string` your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type	Description
`string`	The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this SetBackupTargetPoolRequest to JSON.

Returns
Type	Description
`{ [k: string]: any }`	JSON object

toObject(message, options)

public static toObject(message: google.cloud.compute.v1.SetBackupTargetPoolRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a SetBackupTargetPoolRequest message. Also converts values to other types if specified.

Parameters
Name	Description
`message`	`google.cloud.compute.v1.SetBackupTargetPoolRequest` SetBackupTargetPoolRequest
`options`	`$protobuf.IConversionOptions` Conversion options

Returns
Type	Description
`{ [k: string]: any }`	Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a SetBackupTargetPoolRequest message.

Parameter
Name	Description
`message`	`{ [k: string]: any }` Plain object to verify

Returns
Type	Description
`(string\|null)`	`null` if valid, otherwise the reason why it is not