Class DnsAuthorization (0.47.0)

public final class DnsAuthorization extends GeneratedMessageV3 implements DnsAuthorizationOrBuilder

A DnsAuthorization resource describes a way to perform domain authorization for certificate issuance.

Protobuf type google.cloud.certificatemanager.v1.DnsAuthorization

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DNS_RESOURCE_RECORD_FIELD_NUMBER

public static final int DNS_RESOURCE_RECORD_FIELD_NUMBER
Field Value
Type Description
int

DOMAIN_FIELD_NUMBER

public static final int DOMAIN_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DnsAuthorization getDefaultInstance()
Returns
Type Description
DnsAuthorization

getDescriptor()

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

newBuilder()

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

newBuilder(DnsAuthorization prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Set of labels associated with a DnsAuthorization.

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

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

getCreateTime()

public Timestamp getCreateTime()

Output only. The creation timestamp of a DnsAuthorization.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The creation timestamp of a DnsAuthorization.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public DnsAuthorization getDefaultInstanceForType()
Returns
Type Description
DnsAuthorization

getDescription()

public String getDescription()

One or more paragraphs of text description of a DnsAuthorization.

string description = 5;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

One or more paragraphs of text description of a DnsAuthorization.

string description = 5;

Returns
Type Description
ByteString

The bytes for description.

getDnsResourceRecord()

public DnsAuthorization.DnsResourceRecord getDnsResourceRecord()

Output only. DNS Resource Record that needs to be added to DNS configuration.

.google.cloud.certificatemanager.v1.DnsAuthorization.DnsResourceRecord dns_resource_record = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DnsAuthorization.DnsResourceRecord

The dnsResourceRecord.

getDnsResourceRecordOrBuilder()

public DnsAuthorization.DnsResourceRecordOrBuilder getDnsResourceRecordOrBuilder()

Output only. DNS Resource Record that needs to be added to DNS configuration.

.google.cloud.certificatemanager.v1.DnsAuthorization.DnsResourceRecord dns_resource_record = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DnsAuthorization.DnsResourceRecordOrBuilder

getDomain()

public String 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.

string domain = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The domain.

getDomainBytes()

public ByteString getDomainBytes()

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.

string domain = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for domain.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Set of labels associated with a DnsAuthorization.

map<string, string> labels = 4;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Set of labels associated with a DnsAuthorization.

map<string, string> labels = 4;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Set of labels associated with a DnsAuthorization.

map<string, string> labels = 4;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Set of labels associated with a DnsAuthorization.

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public String getName()

A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern projects/*/locations/*/dnsAuthorizations/*.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern projects/*/locations/*/dnsAuthorizations/*.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getType()

public DnsAuthorization.Type getType()

Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used:

  • in location global: FIXED_RECORD.

.google.cloud.certificatemanager.v1.DnsAuthorization.Type type = 11 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
DnsAuthorization.Type

The type.

getTypeValue()

public int getTypeValue()

Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used:

  • in location global: FIXED_RECORD.

.google.cloud.certificatemanager.v1.DnsAuthorization.Type type = 11 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
int

The enum numeric value on the wire for type.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The last update timestamp of a DnsAuthorization.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The last update timestamp of a DnsAuthorization.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The creation timestamp of a DnsAuthorization.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasDnsResourceRecord()

public boolean hasDnsResourceRecord()

Output only. DNS Resource Record that needs to be added to DNS configuration.

.google.cloud.certificatemanager.v1.DnsAuthorization.DnsResourceRecord dns_resource_record = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the dnsResourceRecord field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The last update timestamp of a DnsAuthorization.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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