Reference documentation and code samples for the Compute V1 Client class License.
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.
Generated from protobuf message google.cloud.compute.v1.License
Namespace
Google \ Cloud \ Compute \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ allowed_replacement_licenses
array
Specifies licenseCodes of licenses that can replace this license. Note: such replacements are allowed even if removable_from_disk is false.
↳ appendable_to_disk
bool
If true, this license can be appended to an existing disk's set of licenses.
↳ charges_use_fee
bool
[Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee.
↳ creation_timestamp
string
[Output Only] Creation timestamp in RFC3339 text format.
↳ description
string
An optional textual description of the resource; provided by the client when the resource is created.
↳ id
int|string
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
↳ incompatible_licenses
array
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.
↳ kind
string
[Output Only] Type of resource. Always compute#license for licenses.
↳ license_code
int|string
[Output Only] The unique code used to attach this license to images, snapshots, and disks.
↳ minimum_retention
Duration
If set, this license will be unable to be removed or replaced once attached to a disk until the minimum_retention period has passed.
↳ multi_tenant_only
bool
If true, this license can only be used on VMs on multi tenant nodes.
↳ name
string
Name of the resource. The name must be 1-63 characters long and comply with RFC1035.
↳ os_license
bool
If true, indicates this is an OS license. Only one OS license can be attached to a disk or image at a time.
↳ removable_from_disk
bool
If true, this license can be removed from a disk's set of licenses, with no replacement license needed.
↳ required_coattached_licenses
array
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.
↳ resource_requirements
↳ self_link
string
[Output Only] Server-defined URL for the resource.
↳ self_link_with_id
string
[Output Only] Server-defined URL for this resource with the resource id.
↳ sole_tenant_only
bool
If true, this license can only be used on VMs on sole tenant nodes.
↳ transferable
bool
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.
↳ update_timestamp
string
[Output Only] Last update timestamp in RFC3339 text format.
getAllowedReplacementLicenses
Specifies licenseCodes of licenses that can replace this license. Note: such replacements are allowed even if removable_from_disk is false.
setAllowedReplacementLicenses
Specifies licenseCodes of licenses that can replace this license. Note: such replacements are allowed even if removable_from_disk is false.
var
string[]
$this
getAppendableToDisk
If true, this license can be appended to an existing disk's set of licenses.
bool
hasAppendableToDisk
clearAppendableToDisk
setAppendableToDisk
If true, this license can be appended to an existing disk's set of licenses.
var
bool
$this
getChargesUseFee
[Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee.
bool
hasChargesUseFee
clearChargesUseFee
setChargesUseFee
[Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee.
var
bool
$this
getCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
string
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
var
string
$this
getDescription
An optional textual description of the resource; provided by the client when the resource is created.
string
hasDescription
clearDescription
setDescription
An optional textual description of the resource; provided by the client when the resource is created.
var
string
$this
getId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
int|string
hasId
clearId
setId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
var
int|string
$this
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.
setIncompatibleLicenses
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.
var
string[]
$this
getKind
[Output Only] Type of resource. Always compute#license for licenses.
string
hasKind
clearKind
setKind
[Output Only] Type of resource. Always compute#license for licenses.
var
string
$this
getLicenseCode
[Output Only] The unique code used to attach this license to images, snapshots, and disks.
int|string
hasLicenseCode
clearLicenseCode
setLicenseCode
[Output Only] The unique code used to attach this license to images, snapshots, and disks.
var
int|string
$this
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.
hasMinimumRetention
clearMinimumRetention
setMinimumRetention
If set, this license will be unable to be removed or replaced once attached to a disk until the minimum_retention period has passed.
$this
getMultiTenantOnly
If true, this license can only be used on VMs on multi tenant nodes.
bool
hasMultiTenantOnly
clearMultiTenantOnly
setMultiTenantOnly
If true, this license can only be used on VMs on multi tenant nodes.
var
bool
$this
getName
Name of the resource. The name must be 1-63 characters long and comply with RFC1035.
string
hasName
clearName
setName
Name of the resource. The name must be 1-63 characters long and comply with RFC1035.
var
string
$this
getOsLicense
If true, indicates this is an OS license. Only one OS license can be attached to a disk or image at a time.
bool
hasOsLicense
clearOsLicense
setOsLicense
If true, indicates this is an OS license. Only one OS license can be attached to a disk or image at a time.
var
bool
$this
getRemovableFromDisk
If true, this license can be removed from a disk's set of licenses, with no replacement license needed.
bool
hasRemovableFromDisk
clearRemovableFromDisk
setRemovableFromDisk
If true, this license can be removed from a disk's set of licenses, with no replacement license needed.
var
bool
$this
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.
setRequiredCoattachedLicenses
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.
var
string[]
$this
getResourceRequirements
[Input Only] Deprecated.
hasResourceRequirements
clearResourceRequirements
setResourceRequirements
[Input Only] Deprecated.
$this
getSelfLink
[Output Only] Server-defined URL for the resource.
string
hasSelfLink
clearSelfLink
setSelfLink
[Output Only] Server-defined URL for the resource.
var
string
$this
getSelfLinkWithId
[Output Only] Server-defined URL for this resource with the resource id.
string
hasSelfLinkWithId
clearSelfLinkWithId
setSelfLinkWithId
[Output Only] Server-defined URL for this resource with the resource id.
var
string
$this
getSoleTenantOnly
If true, this license can only be used on VMs on sole tenant nodes.
bool
hasSoleTenantOnly
clearSoleTenantOnly
setSoleTenantOnly
If true, this license can only be used on VMs on sole tenant nodes.
var
bool
$this
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.
bool
hasTransferable
clearTransferable
setTransferable
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.
var
bool
$this
getUpdateTimestamp
[Output Only] Last update timestamp in RFC3339 text format.
string
hasUpdateTimestamp
clearUpdateTimestamp
setUpdateTimestamp
[Output Only] Last update timestamp in RFC3339 text format.
var
string
$this
