Class LicenseCode (1.105.0)

public final class LicenseCode extends GeneratedMessage implements LicenseCodeOrBuilder

Represents a License Code resource.

A License Code is a unique identifier used to represent alicense resource. Caution This resource is intended for use only by third-party partners who are creatingCloud Marketplace images.

Protobuf type google.cloud.compute.v1.LicenseCode

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

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_ALIAS_FIELD_NUMBER

public static final int LICENSE_ALIAS_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
public static final int SELF_LINK_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

STATE_FIELD_NUMBER

public static final int STATE_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 LicenseCode getDefaultInstance()
Returns
Type Description
LicenseCode

getDescriptor()

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

newBuilder()

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

newBuilder(LicenseCode prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

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.

getCreationTimestamp()

public String getCreationTimestamp()

Output only. [Output Only] Creation timestamp inRFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

Output only. [Output Only] Creation timestamp inRFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
ByteString

The bytes for creationTimestamp.

getDefaultInstanceForType()

public LicenseCode getDefaultInstanceForType()
Returns
Type Description
LicenseCode

getDescription()

public String getDescription()

Output only. [Output Only] Description of this License Code.

optional string description = 422937596;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Output only. [Output Only] Description of this License Code.

optional string description = 422937596;

Returns
Type Description
ByteString

The bytes for description.

getId()

public long getId()

Output only. [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. [Output Only] Type of resource. Always compute#licenseCode for licenses.

optional string kind = 3292052;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

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

optional string kind = 3292052;

Returns
Type Description
ByteString

The bytes for kind.

getLicenseAlias(int index)

public LicenseCodeLicenseAlias getLicenseAlias(int index)

[Output Only] URL and description aliases of Licenses with the same License Code.

repeated .google.cloud.compute.v1.LicenseCodeLicenseAlias license_alias = 43550930;

Parameter
Name Description
index int
Returns
Type Description
LicenseCodeLicenseAlias

getLicenseAliasCount()

public int getLicenseAliasCount()

[Output Only] URL and description aliases of Licenses with the same License Code.

repeated .google.cloud.compute.v1.LicenseCodeLicenseAlias license_alias = 43550930;

Returns
Type Description
int

getLicenseAliasList()

public List<LicenseCodeLicenseAlias> getLicenseAliasList()

[Output Only] URL and description aliases of Licenses with the same License Code.

repeated .google.cloud.compute.v1.LicenseCodeLicenseAlias license_alias = 43550930;

Returns
Type Description
List<LicenseCodeLicenseAlias>

getLicenseAliasOrBuilder(int index)

public LicenseCodeLicenseAliasOrBuilder getLicenseAliasOrBuilder(int index)

[Output Only] URL and description aliases of Licenses with the same License Code.

repeated .google.cloud.compute.v1.LicenseCodeLicenseAlias license_alias = 43550930;

Parameter
Name Description
index int
Returns
Type Description
LicenseCodeLicenseAliasOrBuilder

getLicenseAliasOrBuilderList()

public List<? extends LicenseCodeLicenseAliasOrBuilder> getLicenseAliasOrBuilderList()

[Output Only] URL and description aliases of Licenses with the same License Code.

repeated .google.cloud.compute.v1.LicenseCodeLicenseAlias license_alias = 43550930;

Returns
Type Description
List<? extends com.google.cloud.compute.v1.LicenseCodeLicenseAliasOrBuilder>

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()

Output only. [Output Only] Name of the resource. The name is 1-20 characters long and must be a valid 64 bit integer.

optional string name = 3373707;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. [Output Only] Name of the resource. The name is 1-20 characters long and must be a valid 64 bit integer.

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<LicenseCode> getParserForType()
Returns
Type Description
Parser<LicenseCode>
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.

public String getSelfLink()

Output only. [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. [Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
Type Description
ByteString

The bytes for selfLink.

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.

getState()

public String getState()

Output only. [Output Only] Current state of this License Code. Check the State enum for the list of possible values.

optional string state = 109757585;

Returns
Type Description
String

The state.

getStateBytes()

public ByteString getStateBytes()

Output only. [Output Only] Current state of this License Code. Check the State enum for the list of possible values.

optional string state = 109757585;

Returns
Type Description
ByteString

The bytes for state.

getTransferable()

public boolean getTransferable()

Output only. [Output Only] If true, the license will remain attached when creating images or snapshots from disks. Otherwise, the license is not transferred.

optional bool transferable = 4349893;

Returns
Type Description
boolean

The transferable.

getUpdateTimestamp()

public String getUpdateTimestamp()

Output only. [Output Only] Last update timestamp inRFC3339 text format.

optional string update_timestamp = 120894752;

Returns
Type Description
String

The updateTimestamp.

getUpdateTimestampBytes()

public ByteString getUpdateTimestampBytes()

Output only. [Output Only] Last update timestamp inRFC3339 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.

hasCreationTimestamp()

public boolean hasCreationTimestamp()

Output only. [Output Only] Creation timestamp inRFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
boolean

Whether the creationTimestamp field is set.

hasDescription()

public boolean hasDescription()

Output only. [Output Only] Description of this License Code.

optional string description = 422937596;

Returns
Type Description
boolean

Whether the description field is set.

hasId()

public boolean hasId()

Output only. [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. [Output Only] Type of resource. Always compute#licenseCode for licenses.

optional string kind = 3292052;

Returns
Type Description
boolean

Whether the kind 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()

Output only. [Output Only] Name of the resource. The name is 1-20 characters long and must be a valid 64 bit integer.

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.

public boolean hasSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
boolean

Whether the selfLink 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.

hasState()

public boolean hasState()

Output only. [Output Only] Current state of this License Code. Check the State enum for the list of possible values.

optional string state = 109757585;

Returns
Type Description
boolean

Whether the state field is set.

hasTransferable()

public boolean hasTransferable()

Output only. [Output Only] If true, the license will remain attached when creating images or snapshots from disks. Otherwise, the license is not transferred.

optional bool transferable = 4349893;

Returns
Type Description
boolean

Whether the transferable field is set.

hasUpdateTimestamp()

public boolean hasUpdateTimestamp()

Output only. [Output Only] Last update timestamp inRFC3339 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 GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected LicenseCode.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
LicenseCode.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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