Class protos.google.cloud.compute.v1beta.License (6.14.0)

Represents a License.

Implements

Package

@google-cloud/compute

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.compute.v1beta.ILicense);

Constructs a new License.

Parameter
Name Description
properties ILicense

Properties to set

Properties

allowedReplacementLicenses

public allowedReplacementLicenses: string[];

License allowedReplacementLicenses.

appendableToDisk

public appendableToDisk?: (boolean|null);

License appendableToDisk.

chargesUseFee

public chargesUseFee?: (boolean|null);

License chargesUseFee.

creationTimestamp

public creationTimestamp?: (string|null);

License creationTimestamp.

description

public description?: (string|null);

License description.

id

public id?: (number|Long|string|null);

License id.

incompatibleLicenses

public incompatibleLicenses: string[];

License incompatibleLicenses.

kind

public kind?: (string|null);

License kind.

licenseCode

public licenseCode?: (number|Long|string|null);

License licenseCode.

minimumRetention

public minimumRetention?: (google.cloud.compute.v1beta.IDuration|null);

License minimumRetention.

multiTenantOnly

public multiTenantOnly?: (boolean|null);

License multiTenantOnly.

name

public name?: (string|null);

License name.

osLicense

public osLicense?: (boolean|null);

License osLicense.

params

public params?: (google.cloud.compute.v1beta.ILicenseParams|null);

License params.

removableFromDisk

public removableFromDisk?: (boolean|null);

License removableFromDisk.

requiredCoattachedLicenses

public requiredCoattachedLicenses: string[];

License requiredCoattachedLicenses.

resourceRequirements

public resourceRequirements?: (google.cloud.compute.v1beta.ILicenseResourceRequirements|null);

License resourceRequirements.

public selfLink?: (string|null);

License selfLink.

selfLinkWithId

public selfLinkWithId?: (string|null);

License selfLinkWithId.

soleTenantOnly

public soleTenantOnly?: (boolean|null);

License soleTenantOnly.

transferable

public transferable?: (boolean|null);

License transferable.

updateTimestamp

public updateTimestamp?: (string|null);

License updateTimestamp.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1beta.ILicense): google.cloud.compute.v1beta.License;

Creates a new License instance using the specified properties.

Parameter
Name Description
properties ILicense

Properties to set

Returns
Type Description
License

License instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.compute.v1beta.License;

Decodes a License 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
License

License

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.compute.v1beta.License;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
License

License

encode(message, writer)

public static encode(message: google.cloud.compute.v1beta.ILicense, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified License message. Does not implicitly messages.

Parameters
Name Description
message ILicense

License 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.compute.v1beta.ILicense, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ILicense

License 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.compute.v1beta.License;

Creates a License 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
License

License

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for License

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

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message License

License

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