Package com.google.appengine.v1

Class AuthorizedCertificate

  • All Implemented Interfaces:
    AuthorizedCertificateOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class AuthorizedCertificate
extends com.google.protobuf.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
    See Also:
    Serialized Form

    • Field Detail

      • DISPLAY_NAME_FIELD_NUMBER

        public static final int DISPLAY_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DOMAIN_NAMES_FIELD_NUMBER

        public static final int DOMAIN_NAMES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXPIRE_TIME_FIELD_NUMBER

        public static final int EXPIRE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CERTIFICATE_RAW_DATA_FIELD_NUMBER

        public static final int CERTIFICATE_RAW_DATA_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MANAGED_CERTIFICATE_FIELD_NUMBER

        public static final int MANAGED_CERTIFICATE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • VISIBLE_DOMAIN_MAPPINGS_FIELD_NUMBER

        public static final int VISIBLE_DOMAIN_MAPPINGS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DOMAIN_MAPPINGS_COUNT_FIELD_NUMBER

        public static final int DOMAIN_MAPPINGS_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Full path to the `AuthorizedCertificate` resource in the API. Example:
 `apps/myapp/authorizedCertificates/12345`.

 @OutputOnly
        string name = 1;
        Specified by:
        getName in interface AuthorizedCertificateOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Full path to the `AuthorizedCertificate` resource in the API. Example:
 `apps/myapp/authorizedCertificates/12345`.

 @OutputOnly
        string name = 1;
        Specified by:
        getNameBytes in interface AuthorizedCertificateOrBuilder
        Returns:
        The bytes for name.

      • 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;
        Specified by:
        getId in interface AuthorizedCertificateOrBuilder
        Returns:
        The id.

      • getIdBytes

        public com.google.protobuf.ByteString getIdBytes()
         Relative name of the certificate. This is a unique value autogenerated
 on `AuthorizedCertificate` resource creation. Example: `12345`.

 @OutputOnly
        string id = 2;
        Specified by:
        getIdBytes in interface AuthorizedCertificateOrBuilder
        Returns:
        The bytes for id.

      • 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;
        Specified by:
        getDisplayName in interface AuthorizedCertificateOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         The user-specified display name of the certificate. This is not
 guaranteed to be unique. Example: `My Certificate`.
        string display_name = 3;
        Specified by:
        getDisplayNameBytes in interface AuthorizedCertificateOrBuilder
        Returns:
        The bytes for displayName.

      • getDomainNamesList

        public com.google.protobuf.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;
        Specified by:
        getDomainNamesList in interface AuthorizedCertificateOrBuilder
        Returns:
        A list containing the domainNames.

      • 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;
        Specified by:
        getDomainNamesCount in interface AuthorizedCertificateOrBuilder
        Returns:
        The count of domainNames.

      • getDomainNames

        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;
        Specified by:
        getDomainNames in interface AuthorizedCertificateOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The domainNames at the given index.

      • getDomainNamesBytes

        public com.google.protobuf.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;
        Specified by:
        getDomainNamesBytes in interface AuthorizedCertificateOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the domainNames at the given index.

      • 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;
        Specified by:
        hasExpireTime in interface AuthorizedCertificateOrBuilder
        Returns:
        Whether the expireTime field is set.

      • getExpireTime

        public com.google.protobuf.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;
        Specified by:
        getExpireTime in interface AuthorizedCertificateOrBuilder
        Returns:
        The expireTime.

      • getExpireTimeOrBuilder

        public com.google.protobuf.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;
        Specified by:
        getExpireTimeOrBuilder in interface AuthorizedCertificateOrBuilder

      • 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;
        Specified by:
        hasCertificateRawData in interface AuthorizedCertificateOrBuilder
        Returns:
        Whether the certificateRawData field is set.

      • 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;
        Specified by:
        getCertificateRawData in interface AuthorizedCertificateOrBuilder
        Returns:
        The certificateRawData.

      • 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;
        Specified by:
        hasManagedCertificate in interface AuthorizedCertificateOrBuilder
        Returns:
        Whether the managedCertificate field is set.

      • 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;
        Specified by:
        getManagedCertificate in interface AuthorizedCertificateOrBuilder
        Returns:
        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;
        Specified by:
        getManagedCertificateOrBuilder in interface AuthorizedCertificateOrBuilder

      • getVisibleDomainMappingsList

        public com.google.protobuf.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;
        Specified by:
        getVisibleDomainMappingsList in interface AuthorizedCertificateOrBuilder
        Returns:
        A list containing the visibleDomainMappings.

      • 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;
        Specified by:
        getVisibleDomainMappingsCount in interface AuthorizedCertificateOrBuilder
        Returns:
        The count of visibleDomainMappings.

      • getVisibleDomainMappings

        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;
        Specified by:
        getVisibleDomainMappings in interface AuthorizedCertificateOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The visibleDomainMappings at the given index.

      • getVisibleDomainMappingsBytes

        public com.google.protobuf.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;
        Specified by:
        getVisibleDomainMappingsBytes in interface AuthorizedCertificateOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the visibleDomainMappings at the given index.

      • 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;
        Specified by:
        getDomainMappingsCount in interface AuthorizedCertificateOrBuilder
        Returns:
        The domainMappingsCount.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static AuthorizedCertificate parseFrom​(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AuthorizedCertificate parseFrom​(ByteBuffer data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AuthorizedCertificate parseFrom​(com.google.protobuf.ByteString data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AuthorizedCertificate parseFrom​(com.google.protobuf.ByteString data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AuthorizedCertificate parseFrom​(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AuthorizedCertificate parseFrom​(byte[] data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public AuthorizedCertificate.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public AuthorizedCertificate.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected AuthorizedCertificate.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<AuthorizedCertificate> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public AuthorizedCertificate getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder