Reference documentation and code samples for the Google Cloud Certificate Manager V1 Client class DnsAuthorization.
A DnsAuthorization resource describes a way to perform domain authorization for certificate issuance.
Generated from protobuf message google.cloud.certificatemanager.v1.DnsAuthorization
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The creation timestamp of a DnsAuthorization. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The last update timestamp of a DnsAuthorization. |
↳ labels |
array|Google\Protobuf\Internal\MapField
Set of labels associated with a DnsAuthorization. |
↳ description |
string
One or more paragraphs of text description of a DnsAuthorization. |
↳ domain |
string
Required. Immutable. A domain that is being authorized. A DnsAuthorization resource covers a single domain and its wildcard, e.g. authorization for |
↳ dns_resource_record |
Google\Cloud\CertificateManager\V1\DnsAuthorization\DnsResourceRecord
Output only. DNS Resource Record that needs to be added to DNS configuration. |
getName
A user-defined name of the dns authorization. DnsAuthorization names must
be unique globally and match pattern
projects/*/locations/*/dnsAuthorizations/*.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
A user-defined name of the dns authorization. DnsAuthorization names must
be unique globally and match pattern
projects/*/locations/*/dnsAuthorizations/*.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. The creation timestamp of a DnsAuthorization.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. The creation timestamp of a DnsAuthorization.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. The last update timestamp of a DnsAuthorization.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The last update timestamp of a DnsAuthorization.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabels
Set of labels associated with a DnsAuthorization.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setLabels
Set of labels associated with a DnsAuthorization.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
One or more paragraphs of text description of a DnsAuthorization.
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
One or more paragraphs of text description of a DnsAuthorization.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDomain
Required. Immutable. A domain that is being authorized. A DnsAuthorization
resource covers a single domain and its wildcard, e.g. authorization for
example.com can be used to issue certificates for example.com and
*.example.com.
| Returns | |
|---|---|
| Type | Description |
string | |
setDomain
Required. Immutable. A domain that is being authorized. A DnsAuthorization
resource covers a single domain and its wildcard, e.g. authorization for
example.com can be used to issue certificates for example.com and
*.example.com.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDnsResourceRecord
Output only. DNS Resource Record that needs to be added to DNS configuration.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\CertificateManager\V1\DnsAuthorization\DnsResourceRecord|null | |
hasDnsResourceRecord
clearDnsResourceRecord
setDnsResourceRecord
Output only. DNS Resource Record that needs to be added to DNS configuration.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\CertificateManager\V1\DnsAuthorization\DnsResourceRecord
|
| Returns | |
|---|---|
| Type | Description |
$this | |