Class protos.google.cloud.tpu.v2alpha1.QueuedResource (2.6.0)

Represents a QueuedResource.

Package

@google-cloud/tpu

Constructors

(constructor)(properties)

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

Constructs a new QueuedResource.

Parameter
NameDescription
properties IQueuedResource

Properties to set

Properties

bestEffort

public bestEffort?: (google.cloud.tpu.v2alpha1.QueuedResource.IBestEffort|null);

QueuedResource bestEffort.

guaranteed

public guaranteed?: (google.cloud.tpu.v2alpha1.QueuedResource.IGuaranteed|null);

QueuedResource guaranteed.

name

public name: string;

QueuedResource name.

queueingPolicy

public queueingPolicy?: (google.cloud.tpu.v2alpha1.QueuedResource.IQueueingPolicy|null);

QueuedResource queueingPolicy.

reservationName

public reservationName: string;

QueuedResource reservationName.

resource

public resource?: "tpu";

QueuedResource resource.

state

public state?: (google.cloud.tpu.v2alpha1.IQueuedResourceState|null);

QueuedResource state.

tier

public tier?: ("bestEffort"|"guaranteed");

QueuedResource tier.

tpu

public tpu?: (google.cloud.tpu.v2alpha1.QueuedResource.ITpu|null);

QueuedResource tpu.

Methods

create(properties)

public static create(properties?: google.cloud.tpu.v2alpha1.IQueuedResource): google.cloud.tpu.v2alpha1.QueuedResource;

Creates a new QueuedResource instance using the specified properties.

Parameter
NameDescription
properties IQueuedResource

Properties to set

Returns
TypeDescription
google.cloud.tpu.v2alpha1.QueuedResource

QueuedResource instance

decode(reader, length)

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

Decodes a QueuedResource message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.tpu.v2alpha1.QueuedResource

QueuedResource

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.tpu.v2alpha1.QueuedResource

QueuedResource

encode(message, writer)

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

Encodes the specified QueuedResource message. Does not implicitly messages.

Parameters
NameDescription
message IQueuedResource

QueuedResource 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.IQueuedResource, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IQueuedResource

QueuedResource 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.QueuedResource;

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

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

Plain object

Returns
TypeDescription
google.cloud.tpu.v2alpha1.QueuedResource

QueuedResource

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for QueuedResource

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.tpu.v2alpha1.QueuedResource

QueuedResource

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 QueuedResource 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