Represents an InstancePolicy.
Package
@google-cloud/batchConstructors
(constructor)(properties)
constructor(properties?: google.cloud.batch.v1.AllocationPolicy.IInstancePolicy);Constructs a new InstancePolicy.
| Parameter | |
|---|---|
| Name | Description |
properties |
IInstancePolicy
Properties to set |
Properties
accelerators
public accelerators: google.cloud.batch.v1.AllocationPolicy.IAccelerator[];InstancePolicy accelerators.
bootDisk
public bootDisk?: (google.cloud.batch.v1.AllocationPolicy.IDisk|null);InstancePolicy bootDisk.
disks
public disks: google.cloud.batch.v1.AllocationPolicy.IAttachedDisk[];InstancePolicy disks.
machineType
public machineType: string;InstancePolicy machineType.
minCpuPlatform
public minCpuPlatform: string;InstancePolicy minCpuPlatform.
provisioningModel
public provisioningModel: (google.cloud.batch.v1.AllocationPolicy.ProvisioningModel|keyof typeof google.cloud.batch.v1.AllocationPolicy.ProvisioningModel);InstancePolicy provisioningModel.
reservation
public reservation: string;InstancePolicy reservation.
Methods
create(properties)
public static create(properties?: google.cloud.batch.v1.AllocationPolicy.IInstancePolicy): google.cloud.batch.v1.AllocationPolicy.InstancePolicy;Creates a new InstancePolicy instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IInstancePolicy
Properties to set |
| Returns | |
|---|---|
| Type | Description |
InstancePolicy |
InstancePolicy instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.batch.v1.AllocationPolicy.InstancePolicy;Decodes an InstancePolicy message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
InstancePolicy |
InstancePolicy |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.batch.v1.AllocationPolicy.InstancePolicy;Decodes an InstancePolicy message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
InstancePolicy |
InstancePolicy |
encode(message, writer)
public static encode(message: google.cloud.batch.v1.AllocationPolicy.IInstancePolicy, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified InstancePolicy message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IInstancePolicy
InstancePolicy 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.cloud.batch.v1.AllocationPolicy.IInstancePolicy, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified InstancePolicy message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IInstancePolicy
InstancePolicy 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.cloud.batch.v1.AllocationPolicy.InstancePolicy;Creates an InstancePolicy 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 |
InstancePolicy |
InstancePolicy |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for InstancePolicy
| 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 InstancePolicy to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.batch.v1.AllocationPolicy.InstancePolicy, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an InstancePolicy message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
InstancePolicy
InstancePolicy |
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 InstancePolicy message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|