Class protos.google.storagetransfer.v1.AgentPool (2.1.1)

Version 2.1.1

• 3.4.0 (latest)
• 3.0.0
• 2.3.2
• 2.2.1
• 2.1.1
• 1.2.0
• 1.1.1
• 1.0.1

Represents an AgentPool.

Package

@google-cloud/storage-transfer

Constructors

(constructor)(properties)

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

Constructs a new AgentPool.

Parameter

Name	Description
properties	IAgentPool Properties to set

Properties

bandwidthLimit

public bandwidthLimit?: (google.storagetransfer.v1.AgentPool.IBandwidthLimit|null);

AgentPool bandwidthLimit.

displayName

public displayName: string;

AgentPool displayName.

name

public name: string;

AgentPool name.

state

public state: (google.storagetransfer.v1.AgentPool.State|keyof typeof google.storagetransfer.v1.AgentPool.State);

AgentPool state.

Methods

create(properties)

public static create(properties?: google.storagetransfer.v1.IAgentPool): google.storagetransfer.v1.AgentPool;

Creates a new AgentPool instance using the specified properties.

Parameter

Name	Description
properties	IAgentPool Properties to set

Returns

Type	Description
google.storagetransfer.v1.AgentPool	AgentPool instance

decode(reader, length)

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

Decodes an AgentPool 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.AgentPool	AgentPool

decodeDelimited(reader)

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

Decodes an AgentPool 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.AgentPool	AgentPool

encode(message, writer)

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

Encodes the specified AgentPool message. Does not implicitly messages.

Parameters

Name	Description
message	IAgentPool AgentPool 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.IAgentPool, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	IAgentPool AgentPool 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.AgentPool;

Creates an AgentPool 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.AgentPool	AgentPool

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for AgentPool

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 AgentPool to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	google.storagetransfer.v1.AgentPool AgentPool
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 AgentPool 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