Class DeviceCredential

  • All Implemented Interfaces:
    DeviceCredentialOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class DeviceCredential
    extends com.google.protobuf.GeneratedMessageV3
    implements DeviceCredentialOrBuilder
     A server-stored device credential used for authentication.
     
    Protobuf type google.cloud.iot.v1.DeviceCredential
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  DeviceCredential.Builder
      A server-stored device credential used for authentication.
      static class  DeviceCredential.CredentialCase  
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int EXPIRATION_TIME_FIELD_NUMBER  
      static int PUBLIC_KEY_FIELD_NUMBER  
      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields
      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize
      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode
    • Field Detail

      • PUBLIC_KEY_FIELD_NUMBER

        public static final int PUBLIC_KEY_FIELD_NUMBER
        See Also:
        Constant Field Values
      • EXPIRATION_TIME_FIELD_NUMBER

        public static final int EXPIRATION_TIME_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
      • hasPublicKey

        public boolean hasPublicKey()
         A public key used to verify the signature of JSON Web Tokens (JWTs).
         When adding a new device credential, either via device creation or via
         modifications, this public key credential may be required to be signed by
         one of the registry level certificates. More specifically, if the
         registry contains at least one certificate, any new device credential
         must be signed by one of the registry certificates. As a result,
         when the registry contains certificates, only X.509 certificates are
         accepted as device credentials. However, if the registry does
         not contain a certificate, self-signed certificates and public keys will
         be accepted. New device credentials must be different from every
         registry-level certificate.
         
        .google.cloud.iot.v1.PublicKeyCredential public_key = 2;
        Specified by:
        hasPublicKey in interface DeviceCredentialOrBuilder
        Returns:
        Whether the publicKey field is set.
      • getPublicKey

        public PublicKeyCredential getPublicKey()
         A public key used to verify the signature of JSON Web Tokens (JWTs).
         When adding a new device credential, either via device creation or via
         modifications, this public key credential may be required to be signed by
         one of the registry level certificates. More specifically, if the
         registry contains at least one certificate, any new device credential
         must be signed by one of the registry certificates. As a result,
         when the registry contains certificates, only X.509 certificates are
         accepted as device credentials. However, if the registry does
         not contain a certificate, self-signed certificates and public keys will
         be accepted. New device credentials must be different from every
         registry-level certificate.
         
        .google.cloud.iot.v1.PublicKeyCredential public_key = 2;
        Specified by:
        getPublicKey in interface DeviceCredentialOrBuilder
        Returns:
        The publicKey.
      • getPublicKeyOrBuilder

        public PublicKeyCredentialOrBuilder getPublicKeyOrBuilder()
         A public key used to verify the signature of JSON Web Tokens (JWTs).
         When adding a new device credential, either via device creation or via
         modifications, this public key credential may be required to be signed by
         one of the registry level certificates. More specifically, if the
         registry contains at least one certificate, any new device credential
         must be signed by one of the registry certificates. As a result,
         when the registry contains certificates, only X.509 certificates are
         accepted as device credentials. However, if the registry does
         not contain a certificate, self-signed certificates and public keys will
         be accepted. New device credentials must be different from every
         registry-level certificate.
         
        .google.cloud.iot.v1.PublicKeyCredential public_key = 2;
        Specified by:
        getPublicKeyOrBuilder in interface DeviceCredentialOrBuilder
      • hasExpirationTime

        public boolean hasExpirationTime()
         [Optional] The time at which this credential becomes invalid. This
         credential will be ignored for new client authentication requests after
         this timestamp; however, it will not be automatically deleted.
         
        .google.protobuf.Timestamp expiration_time = 6;
        Specified by:
        hasExpirationTime in interface DeviceCredentialOrBuilder
        Returns:
        Whether the expirationTime field is set.
      • getExpirationTime

        public com.google.protobuf.Timestamp getExpirationTime()
         [Optional] The time at which this credential becomes invalid. This
         credential will be ignored for new client authentication requests after
         this timestamp; however, it will not be automatically deleted.
         
        .google.protobuf.Timestamp expiration_time = 6;
        Specified by:
        getExpirationTime in interface DeviceCredentialOrBuilder
        Returns:
        The expirationTime.
      • getExpirationTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getExpirationTimeOrBuilder()
         [Optional] The time at which this credential becomes invalid. This
         credential will be ignored for new client authentication requests after
         this timestamp; however, it will not be automatically deleted.
         
        .google.protobuf.Timestamp expiration_time = 6;
        Specified by:
        getExpirationTimeOrBuilder in interface DeviceCredentialOrBuilder
      • 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 DeviceCredential parseFrom​(ByteBuffer data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

        public static DeviceCredential parseFrom​(com.google.protobuf.CodedInputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException
        Throws:
        IOException
      • newBuilderForType

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

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

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

        public com.google.protobuf.Parser<DeviceCredential> 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 DeviceCredential getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder