Class RestorePlan

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.gkebackup.v1.RestorePlan
All Implemented Interfaces:
RestorePlanOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class RestorePlan extends com.google.protobuf.GeneratedMessage implements RestorePlanOrBuilder
 The configuration of a potential series of Restore operations to be performed
 against Backups belong to a particular BackupPlan.
 
Protobuf type google.cloud.gkebackup.v1.RestorePlan
See Also:
  • Field Details

  • Method Details

    • getDescriptor

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

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • getName

      public String getName()
       Output only. The full name of the RestorePlan resource.
       Format: `projects/*/locations/*/restorePlans/*`.
       
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getName in interface RestorePlanOrBuilder
      Returns:
      The name.
    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Output only. The full name of the RestorePlan resource.
       Format: `projects/*/locations/*/restorePlans/*`.
       
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getNameBytes in interface RestorePlanOrBuilder
      Returns:
      The bytes for name.
    • getUid

      public String getUid()
       Output only. Server generated global unique identifier of
       [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
       
      string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUid in interface RestorePlanOrBuilder
      Returns:
      The uid.
    • getUidBytes

      public com.google.protobuf.ByteString getUidBytes()
       Output only. Server generated global unique identifier of
       [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
       
      string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUidBytes in interface RestorePlanOrBuilder
      Returns:
      The bytes for uid.
    • hasCreateTime

      public boolean hasCreateTime()
       Output only. The timestamp when this RestorePlan resource was
       created.
       
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface RestorePlanOrBuilder
      Returns:
      Whether the createTime field is set.
    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. The timestamp when this RestorePlan resource was
       created.
       
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface RestorePlanOrBuilder
      Returns:
      The createTime.
    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The timestamp when this RestorePlan resource was
       created.
       
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface RestorePlanOrBuilder
    • hasUpdateTime

      public boolean hasUpdateTime()
       Output only. The timestamp when this RestorePlan resource was last
       updated.
       
      .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasUpdateTime in interface RestorePlanOrBuilder
      Returns:
      Whether the updateTime field is set.
    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       Output only. The timestamp when this RestorePlan resource was last
       updated.
       
      .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTime in interface RestorePlanOrBuilder
      Returns:
      The updateTime.
    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The timestamp when this RestorePlan resource was last
       updated.
       
      .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface RestorePlanOrBuilder
    • getDescription

      public String getDescription()
       Optional. User specified descriptive string for this RestorePlan.
       
      string description = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescription in interface RestorePlanOrBuilder
      Returns:
      The description.
    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Optional. User specified descriptive string for this RestorePlan.
       
      string description = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescriptionBytes in interface RestorePlanOrBuilder
      Returns:
      The bytes for description.
    • getBackupPlan

      public String getBackupPlan()
       Required. Immutable. A reference to the
       [BackupPlan][google.cloud.gkebackup.v1.BackupPlan] from which Backups may
       be used as the source for Restores created via this RestorePlan. Format:
       `projects/*/locations/*/backupPlans/*`.
       
      string backup_plan = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getBackupPlan in interface RestorePlanOrBuilder
      Returns:
      The backupPlan.
    • getBackupPlanBytes

      public com.google.protobuf.ByteString getBackupPlanBytes()
       Required. Immutable. A reference to the
       [BackupPlan][google.cloud.gkebackup.v1.BackupPlan] from which Backups may
       be used as the source for Restores created via this RestorePlan. Format:
       `projects/*/locations/*/backupPlans/*`.
       
      string backup_plan = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getBackupPlanBytes in interface RestorePlanOrBuilder
      Returns:
      The bytes for backupPlan.
    • getCluster

      public String getCluster()
       Required. Immutable. The target cluster into which Restores created via
       this RestorePlan will restore data. NOTE: the cluster's region must be the
       same as the RestorePlan. Valid formats:
      
       - `projects/*/locations/*/clusters/*`
       - `projects/*/zones/*/clusters/*`
       
      string cluster = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getCluster in interface RestorePlanOrBuilder
      Returns:
      The cluster.
    • getClusterBytes

      public com.google.protobuf.ByteString getClusterBytes()
       Required. Immutable. The target cluster into which Restores created via
       this RestorePlan will restore data. NOTE: the cluster's region must be the
       same as the RestorePlan. Valid formats:
      
       - `projects/*/locations/*/clusters/*`
       - `projects/*/zones/*/clusters/*`
       
      string cluster = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getClusterBytes in interface RestorePlanOrBuilder
      Returns:
      The bytes for cluster.
    • hasRestoreConfig

      public boolean hasRestoreConfig()
       Required. Configuration of Restores created via this RestorePlan.
       
      .google.cloud.gkebackup.v1.RestoreConfig restore_config = 8 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasRestoreConfig in interface RestorePlanOrBuilder
      Returns:
      Whether the restoreConfig field is set.
    • getRestoreConfig

      public RestoreConfig getRestoreConfig()
       Required. Configuration of Restores created via this RestorePlan.
       
      .google.cloud.gkebackup.v1.RestoreConfig restore_config = 8 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getRestoreConfig in interface RestorePlanOrBuilder
      Returns:
      The restoreConfig.
    • getRestoreConfigOrBuilder

      public RestoreConfigOrBuilder getRestoreConfigOrBuilder()
       Required. Configuration of Restores created via this RestorePlan.
       
      .google.cloud.gkebackup.v1.RestoreConfig restore_config = 8 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getRestoreConfigOrBuilder in interface RestorePlanOrBuilder
    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: RestorePlanOrBuilder
       Optional. A set of custom labels supplied by user.
       
      map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsCount in interface RestorePlanOrBuilder
    • containsLabels

      public boolean containsLabels(String key)
       Optional. A set of custom labels supplied by user.
       
      map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsLabels in interface RestorePlanOrBuilder
    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface RestorePlanOrBuilder
    • getLabelsMap

      public Map<String,String> getLabelsMap()
       Optional. A set of custom labels supplied by user.
       
      map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsMap in interface RestorePlanOrBuilder
    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       Optional. A set of custom labels supplied by user.
       
      map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrDefault in interface RestorePlanOrBuilder
    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       Optional. A set of custom labels supplied by user.
       
      map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrThrow in interface RestorePlanOrBuilder
    • getEtag

      public String getEtag()
       Output only. `etag` is used for optimistic concurrency control as a way to
       help prevent simultaneous updates of a restore from overwriting each other.
       It is strongly suggested that systems make use of the `etag` in the
       read-modify-write cycle to perform restore updates in order to avoid
       race conditions: An `etag` is returned in the response to `GetRestorePlan`,
       and systems are expected to put that etag in the request to
       `UpdateRestorePlan` or `DeleteRestorePlan` to ensure that their change
       will be applied to the same version of the resource.
       
      string etag = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEtag in interface RestorePlanOrBuilder
      Returns:
      The etag.
    • getEtagBytes

      public com.google.protobuf.ByteString getEtagBytes()
       Output only. `etag` is used for optimistic concurrency control as a way to
       help prevent simultaneous updates of a restore from overwriting each other.
       It is strongly suggested that systems make use of the `etag` in the
       read-modify-write cycle to perform restore updates in order to avoid
       race conditions: An `etag` is returned in the response to `GetRestorePlan`,
       and systems are expected to put that etag in the request to
       `UpdateRestorePlan` or `DeleteRestorePlan` to ensure that their change
       will be applied to the same version of the resource.
       
      string etag = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEtagBytes in interface RestorePlanOrBuilder
      Returns:
      The bytes for etag.
    • getStateValue

      public int getStateValue()
       Output only. State of the RestorePlan. This State field reflects the
       various stages a RestorePlan can be in
       during the Create operation.
       
      .google.cloud.gkebackup.v1.RestorePlan.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStateValue in interface RestorePlanOrBuilder
      Returns:
      The enum numeric value on the wire for state.
    • getState

      public RestorePlan.State getState()
       Output only. State of the RestorePlan. This State field reflects the
       various stages a RestorePlan can be in
       during the Create operation.
       
      .google.cloud.gkebackup.v1.RestorePlan.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getState in interface RestorePlanOrBuilder
      Returns:
      The state.
    • getStateReason

      public String getStateReason()
       Output only. Human-readable description of why RestorePlan is in the
       current `state`. This field is only meant for human readability and should
       not be used programmatically as this field is not guaranteed to be
       consistent.
       
      string state_reason = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStateReason in interface RestorePlanOrBuilder
      Returns:
      The stateReason.
    • getStateReasonBytes

      public com.google.protobuf.ByteString getStateReasonBytes()
       Output only. Human-readable description of why RestorePlan is in the
       current `state`. This field is only meant for human readability and should
       not be used programmatically as this field is not guaranteed to be
       consistent.
       
      string state_reason = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStateReasonBytes in interface RestorePlanOrBuilder
      Returns:
      The bytes for stateReason.
    • getRestoreChannel

      public String getRestoreChannel()
       Output only. The fully qualified name of the RestoreChannel to be used to
       create a RestorePlan. This field is set only if the `backup_plan` is in a
       different project than the RestorePlan. Format:
       `projects/*/locations/*/restoreChannels/*`
       
      string restore_channel = 13 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getRestoreChannel in interface RestorePlanOrBuilder
      Returns:
      The restoreChannel.
    • getRestoreChannelBytes

      public com.google.protobuf.ByteString getRestoreChannelBytes()
       Output only. The fully qualified name of the RestoreChannel to be used to
       create a RestorePlan. This field is set only if the `backup_plan` is in a
       different project than the RestorePlan. Format:
       `projects/*/locations/*/restoreChannels/*`
       
      string restore_channel = 13 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getRestoreChannelBytes in interface RestorePlanOrBuilder
      Returns:
      The bytes for restoreChannel.
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • 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.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • 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 RestorePlan parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

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

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

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

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

      public static RestorePlan parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static RestorePlan parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static RestorePlan parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static RestorePlan parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static RestorePlan parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

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

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

      public static RestorePlan.Builder newBuilder()
    • newBuilder

      public static RestorePlan.Builder newBuilder(RestorePlan prototype)
    • toBuilder

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

      protected RestorePlan.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static RestorePlan getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<RestorePlan> parser()
    • getParserForType

      public com.google.protobuf.Parser<RestorePlan> 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.GeneratedMessage
    • getDefaultInstanceForType

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