com.google.api.services.compute.model

Class License

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.compute.model.License

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class License
extends com.google.api.client.json.GenericJson

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.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
License()

Method Summary

Modifier and Type	Method and Description
License	clone()
List<String>	getAllowedReplacementLicenses() Specifies licenseCodes of licenses that can replace this license.
Boolean	getAppendableToDisk() If true, this license can be appended to an existing disk's set of licenses.
Boolean	getChargesUseFee() [Output Only] Deprecated.
String	getCreationTimestamp() [Output Only] Creation timestamp in RFC3339 text format.
String	getDescription() An optional textual description of the resource; provided by the client when the resource is created.
BigInteger	getId() [Output Only] The unique identifier for the resource.
List<String>	getIncompatibleLicenses() Specifies licenseCodes of licenses that are incompatible with this license.
String	getKind() [Output Only] Type of resource.
BigInteger	getLicenseCode() [Output Only] The unique code used to attach this license to images, snapshots, and disks.
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.
Boolean	getMultiTenantOnly() If true, this license can only be used on VMs on multi tenant nodes.
String	getName() Name of the resource.
Boolean	getOsLicense() If true, indicates this is an OS license.
Boolean	getRemovableFromDisk() If true, this license can be removed from a disk's set of licenses, with no replacement license needed.
List<String>	getRequiredCoattachedLicenses() Specifies the set of permissible coattached licenseCodes of licenses that satisfy the coattachment requirement of this license.
LicenseResourceRequirements	getResourceRequirements() [Input Only] Deprecated.
String	getSelfLink() [Output Only] Server-defined URL for the resource.
String	getSelfLinkWithId() [Output Only] Server-defined URL for this resource with the resource id.
Boolean	getSoleTenantOnly() If true, this license can only be used on VMs on sole tenant nodes.
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.
String	getUpdateTimestamp() [Output Only] Last update timestamp in RFC3339 text format.
License	set(String fieldName, Object value)
License	setAllowedReplacementLicenses(List<String> allowedReplacementLicenses) Specifies licenseCodes of licenses that can replace this license.
License	setAppendableToDisk(Boolean appendableToDisk) If true, this license can be appended to an existing disk's set of licenses.
License	setChargesUseFee(Boolean chargesUseFee) [Output Only] Deprecated.
License	setCreationTimestamp(String creationTimestamp) [Output Only] Creation timestamp in RFC3339 text format.
License	setDescription(String description) An optional textual description of the resource; provided by the client when the resource is created.
License	setId(BigInteger id) [Output Only] The unique identifier for the resource.
License	setIncompatibleLicenses(List<String> incompatibleLicenses) Specifies licenseCodes of licenses that are incompatible with this license.
License	setKind(String kind) [Output Only] Type of resource.
License	setLicenseCode(BigInteger licenseCode) [Output Only] The unique code used to attach this license to images, snapshots, and disks.
License	setMinimumRetention(Duration minimumRetention) If set, this license will be unable to be removed or replaced once attached to a disk until the minimum_retention period has passed.
License	setMultiTenantOnly(Boolean multiTenantOnly) If true, this license can only be used on VMs on multi tenant nodes.
License	setName(String name) Name of the resource.
License	setOsLicense(Boolean osLicense) If true, indicates this is an OS license.
License	setRemovableFromDisk(Boolean removableFromDisk) If true, this license can be removed from a disk's set of licenses, with no replacement license needed.
License	setRequiredCoattachedLicenses(List<String> requiredCoattachedLicenses) Specifies the set of permissible coattached licenseCodes of licenses that satisfy the coattachment requirement of this license.
License	setResourceRequirements(LicenseResourceRequirements resourceRequirements) [Input Only] Deprecated.
License	setSelfLink(String selfLink) [Output Only] Server-defined URL for the resource.
License	setSelfLinkWithId(String selfLinkWithId) [Output Only] Server-defined URL for this resource with the resource id.
License	setSoleTenantOnly(Boolean soleTenantOnly) If true, this license can only be used on VMs on sole tenant nodes.
License	setTransferable(Boolean transferable) 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.
License	setUpdateTimestamp(String updateTimestamp) [Output Only] Last update timestamp in RFC3339 text format.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

License

public License()

Method Detail

getAllowedReplacementLicenses

public List<String> getAllowedReplacementLicenses()

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

Returns:

value or null for none

setAllowedReplacementLicenses

public License setAllowedReplacementLicenses(List<String> allowedReplacementLicenses)

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

Parameters:

allowedReplacementLicenses - allowedReplacementLicenses or null for none

getAppendableToDisk

public Boolean getAppendableToDisk()

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

Returns:

value or null for none

setAppendableToDisk

public License setAppendableToDisk(Boolean appendableToDisk)

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

Parameters:

appendableToDisk - appendableToDisk or null for none

getChargesUseFee

public Boolean getChargesUseFee()

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

Returns:

value or null for none

setChargesUseFee

public License setChargesUseFee(Boolean chargesUseFee)

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

Parameters:

chargesUseFee - chargesUseFee or null for none

getCreationTimestamp

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

Returns:

value or null for none

setCreationTimestamp

public License setCreationTimestamp(String creationTimestamp)

[Output Only] Creation timestamp in RFC3339 text format.

Parameters:

creationTimestamp - creationTimestamp or null for none

getDescription

public String getDescription()

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

Returns:

value or null for none

setDescription

public License setDescription(String description)

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

Parameters:

description - description or null for none

getId

public BigInteger getId()

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

Returns:

value or null for none

setId

public License setId(BigInteger id)

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

Parameters:

id - id or null for none

getIncompatibleLicenses

public List<String> getIncompatibleLicenses()

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.

Returns:

value or null for none

setIncompatibleLicenses

public License setIncompatibleLicenses(List<String> incompatibleLicenses)

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.

Parameters:

incompatibleLicenses - incompatibleLicenses or null for none

getKind

public String getKind()

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

Returns:

value or null for none

setKind

public License setKind(String kind)

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

Parameters:

kind - kind or null for none

getLicenseCode

public BigInteger getLicenseCode()

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

Returns:

value or null for none

setLicenseCode

public License setLicenseCode(BigInteger licenseCode)

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

Parameters:

licenseCode - licenseCode or null for none

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.

Returns:

value or null for none

setMinimumRetention

public License setMinimumRetention(Duration minimumRetention)

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

Parameters:

minimumRetention - minimumRetention or null for none

getMultiTenantOnly

public Boolean getMultiTenantOnly()

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

Returns:

value or null for none

setMultiTenantOnly

public License setMultiTenantOnly(Boolean multiTenantOnly)

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

Parameters:

multiTenantOnly - multiTenantOnly or null for none

getName

public String getName()

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

Returns:

value or null for none

setName

public License setName(String name)

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

Parameters:

name - name or null for none

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.

Returns:

value or null for none

setOsLicense

public License setOsLicense(Boolean osLicense)

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

Parameters:

osLicense - osLicense or null for none

getRemovableFromDisk

public Boolean getRemovableFromDisk()

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

Returns:

value or null for none

setRemovableFromDisk

public License setRemovableFromDisk(Boolean removableFromDisk)

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

Parameters:

removableFromDisk - removableFromDisk or null for none

getRequiredCoattachedLicenses

public List<String> getRequiredCoattachedLicenses()

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.

Returns:

value or null for none

setRequiredCoattachedLicenses

public License setRequiredCoattachedLicenses(List<String> requiredCoattachedLicenses)

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.

Parameters:

requiredCoattachedLicenses - requiredCoattachedLicenses or null for none

getResourceRequirements

public LicenseResourceRequirements getResourceRequirements()

[Input Only] Deprecated.

Returns:

value or null for none

setResourceRequirements

public License setResourceRequirements(LicenseResourceRequirements resourceRequirements)

[Input Only] Deprecated.

Parameters:

resourceRequirements - resourceRequirements or null for none

getSelfLink

public String getSelfLink()

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

Returns:

value or null for none

setSelfLink

public License setSelfLink(String selfLink)

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

Parameters:

selfLink - selfLink or null for none

getSelfLinkWithId

public String getSelfLinkWithId()

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

Returns:

value or null for none

setSelfLinkWithId

public License setSelfLinkWithId(String selfLinkWithId)

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

Parameters:

selfLinkWithId - selfLinkWithId or null for none

getSoleTenantOnly

public Boolean getSoleTenantOnly()

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

Returns:

value or null for none

setSoleTenantOnly

public License setSoleTenantOnly(Boolean soleTenantOnly)

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

Parameters:

soleTenantOnly - soleTenantOnly or null for none

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.

Returns:

value or null for none

setTransferable

public License setTransferable(Boolean transferable)

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.

Parameters:

transferable - transferable or null for none

getUpdateTimestamp

public String getUpdateTimestamp()

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

Returns:

value or null for none

setUpdateTimestamp

public License setUpdateTimestamp(String updateTimestamp)

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

Parameters:

updateTimestamp - updateTimestamp or null for none

set

public License set(String fieldName,
                   Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public License clone()

Overrides:

clone in class com.google.api.client.json.GenericJson