Class protos.google.storagetransfer.v1.UpdateAgentPoolRequest (1.2.0)

Represents an UpdateAgentPoolRequest.

Package

@google-cloud/storage-transfer

Constructors

(constructor)(properties)

constructor(properties?: google.storagetransfer.v1.IUpdateAgentPoolRequest);

Constructs a new UpdateAgentPoolRequest.

Parameter
Name Description
properties IUpdateAgentPoolRequest

Properties to set

Properties

agentPool

public agentPool?: (google.storagetransfer.v1.IAgentPool|null);

UpdateAgentPoolRequest agentPool.

updateMask

public updateMask?: (google.protobuf.IFieldMask|null);

UpdateAgentPoolRequest updateMask.

Methods

create(properties)

public static create(properties?: google.storagetransfer.v1.IUpdateAgentPoolRequest): google.storagetransfer.v1.UpdateAgentPoolRequest;

Creates a new UpdateAgentPoolRequest instance using the specified properties.

Parameter
Name Description
properties IUpdateAgentPoolRequest

Properties to set
Returns
Type Description
google.storagetransfer.v1.UpdateAgentPoolRequest

UpdateAgentPoolRequest instance

decode(reader, length)

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

Decodes an UpdateAgentPoolRequest 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.storagetransfer.v1.UpdateAgentPoolRequest

UpdateAgentPoolRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.storagetransfer.v1.UpdateAgentPoolRequest;

Decodes an UpdateAgentPoolRequest 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.storagetransfer.v1.UpdateAgentPoolRequest

UpdateAgentPoolRequest

encode(message, writer)

public static encode(message: google.storagetransfer.v1.IUpdateAgentPoolRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified UpdateAgentPoolRequest message. Does not implicitly messages.

Parameters
Name Description
message IUpdateAgentPoolRequest

UpdateAgentPoolRequest 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.storagetransfer.v1.IUpdateAgentPoolRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IUpdateAgentPoolRequest

UpdateAgentPoolRequest 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.storagetransfer.v1.UpdateAgentPoolRequest;

Creates an UpdateAgentPoolRequest 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.storagetransfer.v1.UpdateAgentPoolRequest

UpdateAgentPoolRequest

toJSON()

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

Converts this UpdateAgentPoolRequest to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message google.storagetransfer.v1.UpdateAgentPoolRequest

UpdateAgentPoolRequest
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 an UpdateAgentPoolRequest 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