Search Results for

    Show / Hide Table of Contents

    Class SnapshotBaseCreateRequest

    Inheritance
    object
    SnapshotBaseCreateRequest
    SnapshotCustomerCreateRequest
    SnapshotEnvironmentCreateRequest
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: System.Dynamic.ExpandoObject
    Syntax
    [GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
    public abstract class SnapshotBaseCreateRequest

    Properties

    Expires

    Time at which the repository becomes eligible for cleanup

    Declaration
    [JsonProperty("expires", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public DateTime? Expires { get; set; }
    Property Value
    DateTime?

    Indices

    The Indices being part of the snapshot.

    Declaration
    [JsonProperty("indices", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public ICollection<string> Indices { get; set; }
    Property Value
    ICollection<string>

    Reason

    The snapshot backup reason will be added to the snapshot name.

    Declaration
    [JsonProperty("reason", Required = Required.Always)]
    [Required(AllowEmptyStrings = true)]
    [JsonConverter(typeof(StringEnumConverter))]
    public BackupReason Reason { get; set; }
    Property Value
    BackupReason

    RepositoryName

    The Repository in which the snapshot will be created.

    Declaration
    [JsonProperty("repositoryName", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public string RepositoryName { get; set; }
    Property Value
    string

    SnapshotInactive

    Snapshot also if the entity is inactive.

    Declaration
    [JsonProperty("snapshotInactive", Required = Required.Always)]
    public bool SnapshotInactive { get; set; }
    Property Value
    bool

    SnapshotName

    The SnapshotName. Must be unique.
    The name usually will be enriched with Reason, ContractVersion and DateTime information.

    Declaration
    [JsonProperty("snapshotName", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public string SnapshotName { get; set; }
    Property Value
    string

    Timestamp

    Timestamp when creating the request (utc). If there is a more recent snapshot in the repository, it will keep/return the latest one,
    instead of creating a new one.

    Declaration
    [JsonProperty("timestamp", Required = Required.Always)]
    [Required(AllowEmptyStrings = true)]
    public DateTime Timestamp { get; set; }
    Property Value
    DateTime

    Methods

    FromJson(string)

    Declaration
    public static SnapshotBaseCreateRequest FromJson(string data)
    Parameters
    string data

    Returns
    SnapshotBaseCreateRequest

    ToJson()

    Declaration
    public string ToJson()
    Returns
    string

    Back to top Generated by DocFX