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

Version 1.2.0

• 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 a GetTransferJobRequest.

Package

@google-cloud/storage-transfer

Constructors

(constructor)(properties)

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

Constructs a new GetTransferJobRequest.

Parameter

Name	Description
properties	IGetTransferJobRequest Properties to set

Properties

jobName

public jobName: string;

GetTransferJobRequest jobName.

projectId

public projectId: string;

GetTransferJobRequest projectId.

Methods

create(properties)

public static create(properties?: google.storagetransfer.v1.IGetTransferJobRequest): google.storagetransfer.v1.GetTransferJobRequest;

Creates a new GetTransferJobRequest instance using the specified properties.

Parameter

Name	Description
properties	IGetTransferJobRequest Properties to set

Returns

Type	Description
google.storagetransfer.v1.GetTransferJobRequest	GetTransferJobRequest instance

decode(reader, length)

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

Decodes a GetTransferJobRequest 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.GetTransferJobRequest	GetTransferJobRequest

decodeDelimited(reader)

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

Decodes a GetTransferJobRequest 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.GetTransferJobRequest	GetTransferJobRequest

encode(message, writer)

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

Encodes the specified GetTransferJobRequest message. Does not implicitly messages.

Parameters

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

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

Parameters

Name	Description
message	IGetTransferJobRequest GetTransferJobRequest 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.GetTransferJobRequest;

Creates a GetTransferJobRequest 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.GetTransferJobRequest	GetTransferJobRequest

toJSON()

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

Converts this GetTransferJobRequest to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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