Class protos.google.cloud.tpu.v2alpha1.QueuedResourceState (3.2.1)

Represents a QueuedResourceState.

Package

@google-cloud/tpu

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.tpu.v2alpha1.IQueuedResourceState);

Constructs a new QueuedResourceState.

Parameter
NameDescription
properties IQueuedResourceState

Properties to set

Properties

acceptedData

public acceptedData?: (google.cloud.tpu.v2alpha1.QueuedResourceState.IAcceptedData|null);

QueuedResourceState acceptedData.

activeData

public activeData?: (google.cloud.tpu.v2alpha1.QueuedResourceState.IActiveData|null);

QueuedResourceState activeData.

creatingData

public creatingData?: (google.cloud.tpu.v2alpha1.QueuedResourceState.ICreatingData|null);

QueuedResourceState creatingData.

deletingData

public deletingData?: (google.cloud.tpu.v2alpha1.QueuedResourceState.IDeletingData|null);

QueuedResourceState deletingData.

failedData

public failedData?: (google.cloud.tpu.v2alpha1.QueuedResourceState.IFailedData|null);

QueuedResourceState failedData.

provisioningData

public provisioningData?: (google.cloud.tpu.v2alpha1.QueuedResourceState.IProvisioningData|null);

QueuedResourceState provisioningData.

state

public state: (google.cloud.tpu.v2alpha1.QueuedResourceState.State|keyof typeof google.cloud.tpu.v2alpha1.QueuedResourceState.State);

QueuedResourceState state.

stateData

public stateData?: ("creatingData"|"acceptedData"|"provisioningData"|"failedData"|"deletingData"|"activeData"|"suspendingData"|"suspendedData");

QueuedResourceState stateData.

stateInitiator

public stateInitiator: (google.cloud.tpu.v2alpha1.QueuedResourceState.StateInitiator|keyof typeof google.cloud.tpu.v2alpha1.QueuedResourceState.StateInitiator);

QueuedResourceState stateInitiator.

suspendedData

public suspendedData?: (google.cloud.tpu.v2alpha1.QueuedResourceState.ISuspendedData|null);

QueuedResourceState suspendedData.

suspendingData

public suspendingData?: (google.cloud.tpu.v2alpha1.QueuedResourceState.ISuspendingData|null);

QueuedResourceState suspendingData.

Methods

create(properties)

public static create(properties?: google.cloud.tpu.v2alpha1.IQueuedResourceState): google.cloud.tpu.v2alpha1.QueuedResourceState;

Creates a new QueuedResourceState instance using the specified properties.

Parameter
NameDescription
properties IQueuedResourceState

Properties to set

Returns
TypeDescription
QueuedResourceState

QueuedResourceState instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.tpu.v2alpha1.QueuedResourceState;

Decodes a QueuedResourceState message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
QueuedResourceState

QueuedResourceState

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.tpu.v2alpha1.QueuedResourceState;

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
QueuedResourceState

QueuedResourceState

encode(message, writer)

public static encode(message: google.cloud.tpu.v2alpha1.IQueuedResourceState, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified QueuedResourceState message. Does not implicitly messages.

Parameters
NameDescription
message IQueuedResourceState

QueuedResourceState message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.tpu.v2alpha1.IQueuedResourceState, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IQueuedResourceState

QueuedResourceState message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.tpu.v2alpha1.QueuedResourceState;

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
QueuedResourceState

QueuedResourceState

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for QueuedResourceState

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this QueuedResourceState to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message QueuedResourceState

QueuedResourceState

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a QueuedResourceState message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not