Class protos.google.cloud.batch.v1alpha.AllocationPolicy (1.8.0)

Represents an AllocationPolicy.

Package

@google-cloud/batch

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.batch.v1alpha.IAllocationPolicy);

Constructs a new AllocationPolicy.

Parameter
NameDescription
properties IAllocationPolicy

Properties to set

Properties

instance

public instance?: (google.cloud.batch.v1alpha.AllocationPolicy.IInstancePolicy|null);

AllocationPolicy instance.

instances

public instances: google.cloud.batch.v1alpha.AllocationPolicy.IInstancePolicyOrTemplate[];

AllocationPolicy instances.

instanceTemplates

public instanceTemplates: string[];

AllocationPolicy instanceTemplates.

labels

public labels: { [k: string]: string };

AllocationPolicy labels.

location

public location?: (google.cloud.batch.v1alpha.AllocationPolicy.ILocationPolicy|null);

AllocationPolicy location.

network

public network?: (google.cloud.batch.v1alpha.AllocationPolicy.INetworkPolicy|null);

AllocationPolicy network.

placement

public placement?: (google.cloud.batch.v1alpha.AllocationPolicy.IPlacementPolicy|null);

AllocationPolicy placement.

provisioningModels

public provisioningModels: google.cloud.batch.v1alpha.AllocationPolicy.ProvisioningModel[];

AllocationPolicy provisioningModels.

serviceAccount

public serviceAccount?: (google.cloud.batch.v1alpha.IServiceAccount|null);

AllocationPolicy serviceAccount.

serviceAccountEmail

public serviceAccountEmail: string;

AllocationPolicy serviceAccountEmail.

tags

public tags: string[];

AllocationPolicy tags.

Methods

create(properties)

public static create(properties?: google.cloud.batch.v1alpha.IAllocationPolicy): google.cloud.batch.v1alpha.AllocationPolicy;

Creates a new AllocationPolicy instance using the specified properties.

Parameter
NameDescription
properties IAllocationPolicy

Properties to set

Returns
TypeDescription
AllocationPolicy

AllocationPolicy instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.batch.v1alpha.AllocationPolicy;

Decodes an AllocationPolicy 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
AllocationPolicy

AllocationPolicy

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.batch.v1alpha.AllocationPolicy;

Decodes an AllocationPolicy message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
AllocationPolicy

AllocationPolicy

encode(message, writer)

public static encode(message: google.cloud.batch.v1alpha.IAllocationPolicy, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified AllocationPolicy message. Does not implicitly messages.

Parameters
NameDescription
message IAllocationPolicy

AllocationPolicy 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.batch.v1alpha.IAllocationPolicy, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IAllocationPolicy

AllocationPolicy 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.batch.v1alpha.AllocationPolicy;

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

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

Plain object

Returns
TypeDescription
AllocationPolicy

AllocationPolicy

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for AllocationPolicy

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message AllocationPolicy

AllocationPolicy

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an AllocationPolicy 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