Class AuthorizedCertificate (2.40.0)

public final class AuthorizedCertificate extends GeneratedMessageV3 implements AuthorizedCertificateOrBuilder

An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.

Protobuf type google.appengine.v1.AuthorizedCertificate

Static Fields

CERTIFICATE_RAW_DATA_FIELD_NUMBER

public static final int CERTIFICATE_RAW_DATA_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

DOMAIN_MAPPINGS_COUNT_FIELD_NUMBER

public static final int DOMAIN_MAPPINGS_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

DOMAIN_NAMES_FIELD_NUMBER

public static final int DOMAIN_NAMES_FIELD_NUMBER
Field Value
TypeDescription
int

EXPIRE_TIME_FIELD_NUMBER

public static final int EXPIRE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
TypeDescription
int

MANAGED_CERTIFICATE_FIELD_NUMBER

public static final int MANAGED_CERTIFICATE_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

VISIBLE_DOMAIN_MAPPINGS_FIELD_NUMBER

public static final int VISIBLE_DOMAIN_MAPPINGS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static AuthorizedCertificate getDefaultInstance()
Returns
TypeDescription
AuthorizedCertificate

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static AuthorizedCertificate.Builder newBuilder()
Returns
TypeDescription
AuthorizedCertificate.Builder

newBuilder(AuthorizedCertificate prototype)

public static AuthorizedCertificate.Builder newBuilder(AuthorizedCertificate prototype)
Parameter
NameDescription
prototypeAuthorizedCertificate
Returns
TypeDescription
AuthorizedCertificate.Builder

parseDelimitedFrom(InputStream input)

public static AuthorizedCertificate parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AuthorizedCertificate
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AuthorizedCertificate parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AuthorizedCertificate
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static AuthorizedCertificate parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
AuthorizedCertificate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AuthorizedCertificate parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AuthorizedCertificate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AuthorizedCertificate parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
AuthorizedCertificate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AuthorizedCertificate parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AuthorizedCertificate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AuthorizedCertificate parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
AuthorizedCertificate
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AuthorizedCertificate parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AuthorizedCertificate
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static AuthorizedCertificate parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AuthorizedCertificate
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AuthorizedCertificate parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AuthorizedCertificate
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static AuthorizedCertificate parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
AuthorizedCertificate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AuthorizedCertificate parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AuthorizedCertificate
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<AuthorizedCertificate> parser()
Returns
TypeDescription
Parser<AuthorizedCertificate>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCertificateRawData()

public CertificateRawData getCertificateRawData()

The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.

.google.appengine.v1.CertificateRawData certificate_raw_data = 6;

Returns
TypeDescription
CertificateRawData

The certificateRawData.

getCertificateRawDataOrBuilder()

public CertificateRawDataOrBuilder getCertificateRawDataOrBuilder()

The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.

.google.appengine.v1.CertificateRawData certificate_raw_data = 6;

Returns
TypeDescription
CertificateRawDataOrBuilder

getDefaultInstanceForType()

public AuthorizedCertificate getDefaultInstanceForType()
Returns
TypeDescription
AuthorizedCertificate

getDisplayName()

public String getDisplayName()

The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.

string display_name = 3;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.

string display_name = 3;

Returns
TypeDescription
ByteString

The bytes for displayName.

getDomainMappingsCount()

public int getDomainMappingsCount()

Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.

Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.

@OutputOnly

int32 domain_mappings_count = 9;

Returns
TypeDescription
int

The domainMappingsCount.

getDomainNames(int index)

public String getDomainNames(int index)

Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.

@OutputOnly

repeated string domain_names = 4;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The domainNames at the given index.

getDomainNamesBytes(int index)

public ByteString getDomainNamesBytes(int index)

Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.

@OutputOnly

repeated string domain_names = 4;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the domainNames at the given index.

getDomainNamesCount()

public int getDomainNamesCount()

Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.

@OutputOnly

repeated string domain_names = 4;

Returns
TypeDescription
int

The count of domainNames.

getDomainNamesList()

public ProtocolStringList getDomainNamesList()

Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.

@OutputOnly

repeated string domain_names = 4;

Returns
TypeDescription
ProtocolStringList

A list containing the domainNames.

getExpireTime()

public Timestamp getExpireTime()

The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.

@OutputOnly

.google.protobuf.Timestamp expire_time = 5;

Returns
TypeDescription
Timestamp

The expireTime.

getExpireTimeOrBuilder()

public TimestampOrBuilder getExpireTimeOrBuilder()

The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.

@OutputOnly

.google.protobuf.Timestamp expire_time = 5;

Returns
TypeDescription
TimestampOrBuilder

getId()

public String getId()

Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.

@OutputOnly

string id = 2;

Returns
TypeDescription
String

The id.

getIdBytes()

public ByteString getIdBytes()

Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.

@OutputOnly

string id = 2;

Returns
TypeDescription
ByteString

The bytes for id.

getManagedCertificate()

public ManagedCertificate getManagedCertificate()

Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.

@OutputOnly

.google.appengine.v1.ManagedCertificate managed_certificate = 7;

Returns
TypeDescription
ManagedCertificate

The managedCertificate.

getManagedCertificateOrBuilder()

public ManagedCertificateOrBuilder getManagedCertificateOrBuilder()

Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.

@OutputOnly

.google.appengine.v1.ManagedCertificate managed_certificate = 7;

Returns
TypeDescription
ManagedCertificateOrBuilder

getName()

public String getName()

Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.

@OutputOnly

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.

@OutputOnly

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<AuthorizedCertificate> getParserForType()
Returns
TypeDescription
Parser<AuthorizedCertificate>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getVisibleDomainMappings(int index)

public String getVisibleDomainMappings(int index)

The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.

This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.

Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.

@OutputOnly

repeated string visible_domain_mappings = 8;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The visibleDomainMappings at the given index.

getVisibleDomainMappingsBytes(int index)

public ByteString getVisibleDomainMappingsBytes(int index)

The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.

This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.

Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.

@OutputOnly

repeated string visible_domain_mappings = 8;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the visibleDomainMappings at the given index.

getVisibleDomainMappingsCount()

public int getVisibleDomainMappingsCount()

The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.

This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.

Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.

@OutputOnly

repeated string visible_domain_mappings = 8;

Returns
TypeDescription
int

The count of visibleDomainMappings.

getVisibleDomainMappingsList()

public ProtocolStringList getVisibleDomainMappingsList()

The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.

This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.

Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.

@OutputOnly

repeated string visible_domain_mappings = 8;

Returns
TypeDescription
ProtocolStringList

A list containing the visibleDomainMappings.

hasCertificateRawData()

public boolean hasCertificateRawData()

The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.

.google.appengine.v1.CertificateRawData certificate_raw_data = 6;

Returns
TypeDescription
boolean

Whether the certificateRawData field is set.

hasExpireTime()

public boolean hasExpireTime()

The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.

@OutputOnly

.google.protobuf.Timestamp expire_time = 5;

Returns
TypeDescription
boolean

Whether the expireTime field is set.

hasManagedCertificate()

public boolean hasManagedCertificate()

Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.

@OutputOnly

.google.appengine.v1.ManagedCertificate managed_certificate = 7;

Returns
TypeDescription
boolean

Whether the managedCertificate field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public AuthorizedCertificate.Builder newBuilderForType()
Returns
TypeDescription
AuthorizedCertificate.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AuthorizedCertificate.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
AuthorizedCertificate.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public AuthorizedCertificate.Builder toBuilder()
Returns
TypeDescription
AuthorizedCertificate.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException