ConfigurationSnapshot Class

  • Reference
Package:
com.azure.data.appconfiguration.models
Maven Artifact:
com.azure:azure-data-appconfiguration:1.6.0
  • java.lang.Object
    • com.azure.data.appconfiguration.models.ConfigurationSnapshot

Implements

JsonSerializable<ConfigurationSnapshot>

public final class ConfigurationSnapshot
implements JsonSerializable<ConfigurationSnapshot>

The ConfigurationSnapshot model.

Constructor Summary

Constructor Description
ConfigurationSnapshot(List<ConfigurationSettingsFilter> filters)

Creates an instance of ConfigurationSnapshot class.

Method Summary

Modifier and Type Method and Description
static ConfigurationSnapshot fromJson(JsonReader jsonReader)

Reads an instance of ConfigurationSnapshot from the JsonReader.
OffsetDateTime getCreatedAt()

Get the createdAt property: The time that the snapshot was created.
String getETag()

Get the eTag property: A value representing the current state of the snapshot.
OffsetDateTime getExpiresAt()

Get the expiresAt property: The time that the snapshot will expire.
List<ConfigurationSettingsFilter> getFilters()

Get the filters property: A list of filters used to filter the key-values included in the snapshot.
Long getItemCount()

Get the itemCount property: The amount of key-values in the snapshot.
String getName()

Get the name property: The name of the snapshot.
Duration getRetentionPeriod()

Get the retentionPeriod property: The amount of time, in seconds, that a snapshot will remain in the archived state before expiring.
Long getSizeInBytes()

Get the sizeInBytes property: The size in bytes of the snapshot.
SnapshotComposition getSnapshotComposition()

Get the snapshotComposition property: The composition type describes how the key-values within the snapshot are composed.
ConfigurationSnapshotStatus getStatus()

Get the status property: The current status of the snapshot.
Map<String,String> getTags()

Get the tags property: The tags of the snapshot.
ConfigurationSnapshot setRetentionPeriod(Duration retentionPeriod)

Set the retentionPeriod property: The amount of time, in seconds, that a snapshot will remain in the archived state before expiring.
ConfigurationSnapshot setSnapshotComposition(SnapshotComposition snapshotComposition)

Set the snapshotComposition property: The composition type describes how the key-values within the snapshot are composed.
ConfigurationSnapshot setTags(Map<String,String> tags)

Set the tags property: The tags of the snapshot.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ConfigurationSnapshot

public ConfigurationSnapshot(List filters)

Creates an instance of ConfigurationSnapshot class.

Parameters:

filters - the filters value to set.

Method Details

fromJson

public static ConfigurationSnapshot fromJson(JsonReader jsonReader)

Reads an instance of ConfigurationSnapshot from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ConfigurationSnapshot if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getCreatedAt

public OffsetDateTime getCreatedAt()

Get the createdAt property: The time that the snapshot was created.

Returns:

the createdAt value.

getETag

public String getETag()

Get the eTag property: A value representing the current state of the snapshot.

Returns:

the eTag value.

getExpiresAt

public OffsetDateTime getExpiresAt()

Get the expiresAt property: The time that the snapshot will expire.

Returns:

the expiresAt value.

getFilters

public List getFilters()

Get the filters property: A list of filters used to filter the key-values included in the snapshot.

Returns:

the filters value.

getItemCount

public Long getItemCount()

Get the itemCount property: The amount of key-values in the snapshot.

Returns:

the itemCount value.

getName

public String getName()

Get the name property: The name of the snapshot.

Returns:

the name value.

getRetentionPeriod

public Duration getRetentionPeriod()

Get the retentionPeriod property: The amount of time, in seconds, that a snapshot will remain in the archived state before expiring. This property is only writable during the creation of a snapshot. If not specified, the default lifetime of key-value revisions will be used.

Returns:

the retentionPeriod value.

getSizeInBytes

public Long getSizeInBytes()

Get the sizeInBytes property: The size in bytes of the snapshot.

Returns:

the sizeInBytes value.

getSnapshotComposition

public SnapshotComposition getSnapshotComposition()

Get the snapshotComposition property: The composition type describes how the key-values within the snapshot are composed. The 'key' composition type ensures there are no two key-values containing the same key. The 'key_label' composition type ensures there are no two key-values containing the same key and label.

Returns:

the snapshotComposition value.

getStatus

public ConfigurationSnapshotStatus getStatus()

Get the status property: The current status of the snapshot.

Returns:

the status value.

getTags

public Map getTags()

Get the tags property: The tags of the snapshot.

Returns:

the tags value.

setRetentionPeriod

public ConfigurationSnapshot setRetentionPeriod(Duration retentionPeriod)

Set the retentionPeriod property: The amount of time, in seconds, that a snapshot will remain in the archived state before expiring. This property is only writable during the creation of a snapshot. If not specified, the default lifetime of key-value revisions will be used.

Parameters:

retentionPeriod - the retentionPeriod value to set.

Returns:

the ConfigurationSnapshot object itself.

setSnapshotComposition

public ConfigurationSnapshot setSnapshotComposition(SnapshotComposition snapshotComposition)

Set the snapshotComposition property: The composition type describes how the key-values within the snapshot are composed. The 'key' composition type ensures there are no two key-values containing the same key. The 'key_label' composition type ensures there are no two key-values containing the same key and label.

Parameters:

snapshotComposition - the snapshotComposition value to set.

Returns:

the ConfigurationSnapshot object itself.

setTags

public ConfigurationSnapshot setTags(Map tags)

Set the tags property: The tags of the snapshot.

Parameters:

tags - the tags value to set.

Returns:

the ConfigurationSnapshot object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to