Package com.google.cloud.secretmanager.v1

Class Rotation

  • All Implemented Interfaces:
    RotationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Rotation
extends com.google.protobuf.GeneratedMessageV3
implements RotationOrBuilder
     The rotation time and period for a
 [Secret][google.cloud.secretmanager.v1.Secret]. At next_rotation_time, Secret
 Manager will send a Pub/Sub notification to the topics configured on the
 Secret. [Secret.topics][google.cloud.secretmanager.v1.Secret.topics] must be
 set to configure rotation.
    Protobuf type google.cloud.secretmanager.v1.Rotation
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Rotation.Builder
      The rotation time and period for a [Secret][google.cloud.secretmanager.v1.Secret].

      • 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 NEXT_ROTATION_TIME_FIELD_NUMBER  
      static int ROTATION_PERIOD_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

      • NEXT_ROTATION_TIME_FIELD_NUMBER

        public static final int NEXT_ROTATION_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ROTATION_PERIOD_FIELD_NUMBER

        public static final int ROTATION_PERIOD_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

      • hasNextRotationTime

        public boolean hasNextRotationTime()
         Optional. Timestamp in UTC at which the
 [Secret][google.cloud.secretmanager.v1.Secret] is scheduled to rotate.
 Cannot be set to less than 300s (5 min) in the future and at most
 3153600000s (100 years).

 [next_rotation_time][google.cloud.secretmanager.v1.Rotation.next_rotation_time]
 MUST  be set if
 [rotation_period][google.cloud.secretmanager.v1.Rotation.rotation_period]
 is set.
        .google.protobuf.Timestamp next_rotation_time = 1 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasNextRotationTime in interface RotationOrBuilder
        Returns:
        Whether the nextRotationTime field is set.

      • getNextRotationTime

        public com.google.protobuf.Timestamp getNextRotationTime()
         Optional. Timestamp in UTC at which the
 [Secret][google.cloud.secretmanager.v1.Secret] is scheduled to rotate.
 Cannot be set to less than 300s (5 min) in the future and at most
 3153600000s (100 years).

 [next_rotation_time][google.cloud.secretmanager.v1.Rotation.next_rotation_time]
 MUST  be set if
 [rotation_period][google.cloud.secretmanager.v1.Rotation.rotation_period]
 is set.
        .google.protobuf.Timestamp next_rotation_time = 1 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getNextRotationTime in interface RotationOrBuilder
        Returns:
        The nextRotationTime.

      • getNextRotationTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getNextRotationTimeOrBuilder()
         Optional. Timestamp in UTC at which the
 [Secret][google.cloud.secretmanager.v1.Secret] is scheduled to rotate.
 Cannot be set to less than 300s (5 min) in the future and at most
 3153600000s (100 years).

 [next_rotation_time][google.cloud.secretmanager.v1.Rotation.next_rotation_time]
 MUST  be set if
 [rotation_period][google.cloud.secretmanager.v1.Rotation.rotation_period]
 is set.
        .google.protobuf.Timestamp next_rotation_time = 1 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getNextRotationTimeOrBuilder in interface RotationOrBuilder

      • hasRotationPeriod

        public boolean hasRotationPeriod()
         Input only. The Duration between rotation notifications. Must be in seconds
 and at least 3600s (1h) and at most 3153600000s (100 years).

 If
 [rotation_period][google.cloud.secretmanager.v1.Rotation.rotation_period]
 is set,
 [next_rotation_time][google.cloud.secretmanager.v1.Rotation.next_rotation_time]
 must be set.
 [next_rotation_time][google.cloud.secretmanager.v1.Rotation.next_rotation_time]
 will be advanced by this period when the service automatically sends
 rotation notifications.
        .google.protobuf.Duration rotation_period = 2 [(.google.api.field_behavior) = INPUT_ONLY];
        Specified by:
        hasRotationPeriod in interface RotationOrBuilder
        Returns:
        Whether the rotationPeriod field is set.

      • getRotationPeriod

        public com.google.protobuf.Duration getRotationPeriod()
         Input only. The Duration between rotation notifications. Must be in seconds
 and at least 3600s (1h) and at most 3153600000s (100 years).

 If
 [rotation_period][google.cloud.secretmanager.v1.Rotation.rotation_period]
 is set,
 [next_rotation_time][google.cloud.secretmanager.v1.Rotation.next_rotation_time]
 must be set.
 [next_rotation_time][google.cloud.secretmanager.v1.Rotation.next_rotation_time]
 will be advanced by this period when the service automatically sends
 rotation notifications.
        .google.protobuf.Duration rotation_period = 2 [(.google.api.field_behavior) = INPUT_ONLY];
        Specified by:
        getRotationPeriod in interface RotationOrBuilder
        Returns:
        The rotationPeriod.

      • getRotationPeriodOrBuilder

        public com.google.protobuf.DurationOrBuilder getRotationPeriodOrBuilder()
         Input only. The Duration between rotation notifications. Must be in seconds
 and at least 3600s (1h) and at most 3153600000s (100 years).

 If
 [rotation_period][google.cloud.secretmanager.v1.Rotation.rotation_period]
 is set,
 [next_rotation_time][google.cloud.secretmanager.v1.Rotation.next_rotation_time]
 must be set.
 [next_rotation_time][google.cloud.secretmanager.v1.Rotation.next_rotation_time]
 will be advanced by this period when the service automatically sends
 rotation notifications.
        .google.protobuf.Duration rotation_period = 2 [(.google.api.field_behavior) = INPUT_ONLY];
        Specified by:
        getRotationPeriodOrBuilder in interface RotationOrBuilder

      • 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 Rotation parseFrom​(ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Rotation getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Rotation> parser()

      • getParserForType

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