Class License (1.74.0)

public final class License extends GeneratedMessageV3 implements LicenseOrBuilder

Represents a License resource. A License represents billing and aggregate usage data for public and marketplace images. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.

Protobuf type google.cloud.compute.v1.License

Implements

LicenseOrBuilder

Static Fields

ALLOWED_REPLACEMENT_LICENSES_FIELD_NUMBER

public static final int ALLOWED_REPLACEMENT_LICENSES_FIELD_NUMBER
Field Value
Type Description
int

APPENDABLE_TO_DISK_FIELD_NUMBER

public static final int APPENDABLE_TO_DISK_FIELD_NUMBER
Field Value
Type Description
int

CHARGES_USE_FEE_FIELD_NUMBER

public static final int CHARGES_USE_FEE_FIELD_NUMBER
Field Value
Type Description
int

CREATION_TIMESTAMP_FIELD_NUMBER

public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

INCOMPATIBLE_LICENSES_FIELD_NUMBER

public static final int INCOMPATIBLE_LICENSES_FIELD_NUMBER
Field Value
Type Description
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
Type Description
int

LICENSE_CODE_FIELD_NUMBER

public static final int LICENSE_CODE_FIELD_NUMBER
Field Value
Type Description
int

MINIMUM_RETENTION_FIELD_NUMBER

public static final int MINIMUM_RETENTION_FIELD_NUMBER
Field Value
Type Description
int

MULTI_TENANT_ONLY_FIELD_NUMBER

public static final int MULTI_TENANT_ONLY_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

OS_LICENSE_FIELD_NUMBER

public static final int OS_LICENSE_FIELD_NUMBER
Field Value
Type Description
int

REMOVABLE_FROM_DISK_FIELD_NUMBER

public static final int REMOVABLE_FROM_DISK_FIELD_NUMBER
Field Value
Type Description
int

REQUIRED_COATTACHED_LICENSES_FIELD_NUMBER

public static final int REQUIRED_COATTACHED_LICENSES_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_REQUIREMENTS_FIELD_NUMBER

public static final int RESOURCE_REQUIREMENTS_FIELD_NUMBER
Field Value
Type Description
int
public static final int SELF_LINK_FIELD_NUMBER
Field Value
Type Description
int
public static final int SELF_LINK_WITH_ID_FIELD_NUMBER
Field Value
Type Description
int

SOLE_TENANT_ONLY_FIELD_NUMBER

public static final int SOLE_TENANT_ONLY_FIELD_NUMBER
Field Value
Type Description
int

TRANSFERABLE_FIELD_NUMBER

public static final int TRANSFERABLE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIMESTAMP_FIELD_NUMBER

public static final int UPDATE_TIMESTAMP_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static License getDefaultInstance()
Returns
Type Description
License

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static License.Builder newBuilder()
Returns
Type Description
License.Builder

newBuilder(License prototype)

public static License.Builder newBuilder(License prototype)
Parameter
Name Description
prototype License
Returns
Type Description
License.Builder

parseDelimitedFrom(InputStream input)

public static License parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
License
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static License parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
License
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static License parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
License
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static License parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
License
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static License parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
License
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static License parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
License
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static License parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
License
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static License parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
License
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static License parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
License
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static License parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
License
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static License parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
License
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static License parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
License
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<License> parser()
Returns
Type Description
Parser<License>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAllowedReplacementLicenses(int index)

public String getAllowedReplacementLicenses(int index)

Specifies licenseCodes of licenses that can replace this license. Note: such replacements are allowed even if removable_from_disk is false.

repeated string allowed_replacement_licenses = 195677718;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The allowedReplacementLicenses at the given index.

getAllowedReplacementLicensesBytes(int index)

public ByteString getAllowedReplacementLicensesBytes(int index)

Specifies licenseCodes of licenses that can replace this license. Note: such replacements are allowed even if removable_from_disk is false.

repeated string allowed_replacement_licenses = 195677718;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the allowedReplacementLicenses at the given index.

getAllowedReplacementLicensesCount()

public int getAllowedReplacementLicensesCount()

Specifies licenseCodes of licenses that can replace this license. Note: such replacements are allowed even if removable_from_disk is false.

repeated string allowed_replacement_licenses = 195677718;

Returns
Type Description
int

The count of allowedReplacementLicenses.

getAllowedReplacementLicensesList()

public ProtocolStringList getAllowedReplacementLicensesList()

Specifies licenseCodes of licenses that can replace this license. Note: such replacements are allowed even if removable_from_disk is false.

repeated string allowed_replacement_licenses = 195677718;

Returns
Type Description
ProtocolStringList

A list containing the allowedReplacementLicenses.

getAppendableToDisk()

public boolean getAppendableToDisk()

If true, this license can be appended to an existing disk's set of licenses.

optional bool appendable_to_disk = 16959254;

Returns
Type Description
boolean

The appendableToDisk.

getChargesUseFee()

public boolean getChargesUseFee()

[Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee.

optional bool charges_use_fee = 372412622;

Returns
Type Description
boolean

The chargesUseFee.

getCreationTimestamp()

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
ByteString

The bytes for creationTimestamp.

getDefaultInstanceForType()

public License getDefaultInstanceForType()
Returns
Type Description
License

getDescription()

public String getDescription()

An optional textual description of the resource; provided by the client when the resource is created.

optional string description = 422937596;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

An optional textual description of the resource; provided by the client when the resource is created.

optional string description = 422937596;

Returns
Type Description
ByteString

The bytes for description.

getId()

public long getId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
long

The id.

getIncompatibleLicenses(int index)

public String getIncompatibleLicenses(int index)

Specifies licenseCodes of licenses that are incompatible with this license. If a license is incompatible with this license, it cannot be attached to the same disk or image.

repeated string incompatible_licenses = 334239768;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The incompatibleLicenses at the given index.

getIncompatibleLicensesBytes(int index)

public ByteString getIncompatibleLicensesBytes(int index)

Specifies licenseCodes of licenses that are incompatible with this license. If a license is incompatible with this license, it cannot be attached to the same disk or image.

repeated string incompatible_licenses = 334239768;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the incompatibleLicenses at the given index.

getIncompatibleLicensesCount()

public int getIncompatibleLicensesCount()

Specifies licenseCodes of licenses that are incompatible with this license. If a license is incompatible with this license, it cannot be attached to the same disk or image.

repeated string incompatible_licenses = 334239768;

Returns
Type Description
int

The count of incompatibleLicenses.

getIncompatibleLicensesList()

public ProtocolStringList getIncompatibleLicensesList()

Specifies licenseCodes of licenses that are incompatible with this license. If a license is incompatible with this license, it cannot be attached to the same disk or image.

repeated string incompatible_licenses = 334239768;

Returns
Type Description
ProtocolStringList

A list containing the incompatibleLicenses.

getKind()

public String getKind()

[Output Only] Type of resource. Always compute#license for licenses.

optional string kind = 3292052;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

[Output Only] Type of resource. Always compute#license for licenses.

optional string kind = 3292052;

Returns
Type Description
ByteString

The bytes for kind.

getLicenseCode()

public long getLicenseCode()

[Output Only] The unique code used to attach this license to images, snapshots, and disks.

optional uint64 license_code = 1467179;

Returns
Type Description
long

The licenseCode.

getMinimumRetention()

public Duration getMinimumRetention()

If set, this license will be unable to be removed or replaced once attached to a disk until the minimum_retention period has passed.

optional .google.cloud.compute.v1.Duration minimum_retention = 155398189;

Returns
Type Description
Duration

The minimumRetention.

getMinimumRetentionOrBuilder()

public DurationOrBuilder getMinimumRetentionOrBuilder()

If set, this license will be unable to be removed or replaced once attached to a disk until the minimum_retention period has passed.

optional .google.cloud.compute.v1.Duration minimum_retention = 155398189;

Returns
Type Description
DurationOrBuilder

getMultiTenantOnly()

public boolean getMultiTenantOnly()

If true, this license can only be used on VMs on multi tenant nodes.

optional bool multi_tenant_only = 274395163;

Returns
Type Description
boolean

The multiTenantOnly.

getName()

public String getName()

Name of the resource. The name must be 1-63 characters long and comply with RFC1035.

optional string name = 3373707;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Name of the resource. The name must be 1-63 characters long and comply with RFC1035.

optional string name = 3373707;

Returns
Type Description
ByteString

The bytes for name.

getOsLicense()

public boolean getOsLicense()

If true, indicates this is an OS license. Only one OS license can be attached to a disk or image at a time.

optional bool os_license = 487986406;

Returns
Type Description
boolean

The osLicense.

getParserForType()

public Parser<License> getParserForType()
Returns
Type Description
Parser<License>
Overrides

getRemovableFromDisk()

public boolean getRemovableFromDisk()

If true, this license can be removed from a disk's set of licenses, with no replacement license needed.

optional bool removable_from_disk = 25854638;

Returns
Type Description
boolean

The removableFromDisk.

getRequiredCoattachedLicenses(int index)

public String getRequiredCoattachedLicenses(int index)

Specifies the set of permissible coattached licenseCodes of licenses that satisfy the coattachment requirement of this license. At least one license from the set must be attached to the same disk or image as this license.

repeated string required_coattached_licenses = 129195265;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The requiredCoattachedLicenses at the given index.

getRequiredCoattachedLicensesBytes(int index)

public ByteString getRequiredCoattachedLicensesBytes(int index)

Specifies the set of permissible coattached licenseCodes of licenses that satisfy the coattachment requirement of this license. At least one license from the set must be attached to the same disk or image as this license.

repeated string required_coattached_licenses = 129195265;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the requiredCoattachedLicenses at the given index.

getRequiredCoattachedLicensesCount()

public int getRequiredCoattachedLicensesCount()

Specifies the set of permissible coattached licenseCodes of licenses that satisfy the coattachment requirement of this license. At least one license from the set must be attached to the same disk or image as this license.

repeated string required_coattached_licenses = 129195265;

Returns
Type Description
int

The count of requiredCoattachedLicenses.

getRequiredCoattachedLicensesList()

public ProtocolStringList getRequiredCoattachedLicensesList()

Specifies the set of permissible coattached licenseCodes of licenses that satisfy the coattachment requirement of this license. At least one license from the set must be attached to the same disk or image as this license.

repeated string required_coattached_licenses = 129195265;

Returns
Type Description
ProtocolStringList

A list containing the requiredCoattachedLicenses.

getResourceRequirements()

public LicenseResourceRequirements getResourceRequirements()

[Input Only] Deprecated.

optional .google.cloud.compute.v1.LicenseResourceRequirements resource_requirements = 214292769;

Returns
Type Description
LicenseResourceRequirements

The resourceRequirements.

getResourceRequirementsOrBuilder()

public LicenseResourceRequirementsOrBuilder getResourceRequirementsOrBuilder()

[Input Only] Deprecated.

optional .google.cloud.compute.v1.LicenseResourceRequirements resource_requirements = 214292769;

Returns
Type Description
LicenseResourceRequirementsOrBuilder
public String getSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
Type Description
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
Type Description
ByteString

The bytes for selfLink.

getSelfLinkWithId()

public String getSelfLinkWithId()

[Output Only] Server-defined URL for this resource with the resource id.

optional string self_link_with_id = 44520962;

Returns
Type Description
String

The selfLinkWithId.

getSelfLinkWithIdBytes()

public ByteString getSelfLinkWithIdBytes()

[Output Only] Server-defined URL for this resource with the resource id.

optional string self_link_with_id = 44520962;

Returns
Type Description
ByteString

The bytes for selfLinkWithId.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSoleTenantOnly()

public boolean getSoleTenantOnly()

If true, this license can only be used on VMs on sole tenant nodes.

optional bool sole_tenant_only = 427525559;

Returns
Type Description
boolean

The soleTenantOnly.

getTransferable()

public boolean getTransferable()

If false, licenses will not be copied from the source resource when creating an image from a disk, disk from snapshot, or snapshot from disk.

optional bool transferable = 4349893;

Returns
Type Description
boolean

The transferable.

getUpdateTimestamp()

public String getUpdateTimestamp()

[Output Only] Last update timestamp in RFC3339 text format.

optional string update_timestamp = 120894752;

Returns
Type Description
String

The updateTimestamp.

getUpdateTimestampBytes()

public ByteString getUpdateTimestampBytes()

[Output Only] Last update timestamp in RFC3339 text format.

optional string update_timestamp = 120894752;

Returns
Type Description
ByteString

The bytes for updateTimestamp.

hasAppendableToDisk()

public boolean hasAppendableToDisk()

If true, this license can be appended to an existing disk's set of licenses.

optional bool appendable_to_disk = 16959254;

Returns
Type Description
boolean

Whether the appendableToDisk field is set.

hasChargesUseFee()

public boolean hasChargesUseFee()

[Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee.

optional bool charges_use_fee = 372412622;

Returns
Type Description
boolean

Whether the chargesUseFee field is set.

hasCreationTimestamp()

public boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
boolean

Whether the creationTimestamp field is set.

hasDescription()

public boolean hasDescription()

An optional textual description of the resource; provided by the client when the resource is created.

optional string description = 422937596;

Returns
Type Description
boolean

Whether the description field is set.

hasId()

public boolean hasId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
boolean

Whether the id field is set.

hasKind()

public boolean hasKind()

[Output Only] Type of resource. Always compute#license for licenses.

optional string kind = 3292052;

Returns
Type Description
boolean

Whether the kind field is set.

hasLicenseCode()

public boolean hasLicenseCode()

[Output Only] The unique code used to attach this license to images, snapshots, and disks.

optional uint64 license_code = 1467179;

Returns
Type Description
boolean

Whether the licenseCode field is set.

hasMinimumRetention()

public boolean hasMinimumRetention()

If set, this license will be unable to be removed or replaced once attached to a disk until the minimum_retention period has passed.

optional .google.cloud.compute.v1.Duration minimum_retention = 155398189;

Returns
Type Description
boolean

Whether the minimumRetention field is set.

hasMultiTenantOnly()

public boolean hasMultiTenantOnly()

If true, this license can only be used on VMs on multi tenant nodes.

optional bool multi_tenant_only = 274395163;

Returns
Type Description
boolean

Whether the multiTenantOnly field is set.

hasName()

public boolean hasName()

Name of the resource. The name must be 1-63 characters long and comply with RFC1035.

optional string name = 3373707;

Returns
Type Description
boolean

Whether the name field is set.

hasOsLicense()

public boolean hasOsLicense()

If true, indicates this is an OS license. Only one OS license can be attached to a disk or image at a time.

optional bool os_license = 487986406;

Returns
Type Description
boolean

Whether the osLicense field is set.

hasRemovableFromDisk()

public boolean hasRemovableFromDisk()

If true, this license can be removed from a disk's set of licenses, with no replacement license needed.

optional bool removable_from_disk = 25854638;

Returns
Type Description
boolean

Whether the removableFromDisk field is set.

hasResourceRequirements()

public boolean hasResourceRequirements()

[Input Only] Deprecated.

optional .google.cloud.compute.v1.LicenseResourceRequirements resource_requirements = 214292769;

Returns
Type Description
boolean

Whether the resourceRequirements field is set.

public boolean hasSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
Type Description
boolean

Whether the selfLink field is set.

hasSelfLinkWithId()

public boolean hasSelfLinkWithId()

[Output Only] Server-defined URL for this resource with the resource id.

optional string self_link_with_id = 44520962;

Returns
Type Description
boolean

Whether the selfLinkWithId field is set.

hasSoleTenantOnly()

public boolean hasSoleTenantOnly()

If true, this license can only be used on VMs on sole tenant nodes.

optional bool sole_tenant_only = 427525559;

Returns
Type Description
boolean

Whether the soleTenantOnly field is set.

hasTransferable()

public boolean hasTransferable()

If false, licenses will not be copied from the source resource when creating an image from a disk, disk from snapshot, or snapshot from disk.

optional bool transferable = 4349893;

Returns
Type Description
boolean

Whether the transferable field is set.

hasUpdateTimestamp()

public boolean hasUpdateTimestamp()

[Output Only] Last update timestamp in RFC3339 text format.

optional string update_timestamp = 120894752;

Returns
Type Description
boolean

Whether the updateTimestamp field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public License.Builder newBuilderForType()
Returns
Type Description
License.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected License.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
License.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public License.Builder toBuilder()
Returns
Type Description
License.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException