Share via

BlobInventoryPolicyDefinition Class

  • Reference
Package:
com.azure.resourcemanager.storage.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-storage:2.44.0
  • java.lang.Object
    • com.azure.resourcemanager.storage.models.BlobInventoryPolicyDefinition

Implements

JsonSerializable<BlobInventoryPolicyDefinition>

public final class BlobInventoryPolicyDefinition
implements JsonSerializable<BlobInventoryPolicyDefinition>

An object that defines the blob inventory rule.

Constructor Summary

Constructor Description
BlobInventoryPolicyDefinition()

Creates an instance of BlobInventoryPolicyDefinition class.

Method Summary

Modifier and Type Method and Description
BlobInventoryPolicyFilter filters()

Get the filters property: An object that defines the filter set.
Format format()

Get the format property: This is a required field, it specifies the format for the inventory files.
static BlobInventoryPolicyDefinition fromJson(JsonReader jsonReader)

Reads an instance of BlobInventoryPolicyDefinition from the JsonReader.
ObjectType objectType()

Get the objectType property: This is a required field.
Schedule schedule()

Get the schedule property: This is a required field.
List<String> schemaFields()

Get the schemaFields property: This is a required field.
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
BlobInventoryPolicyDefinition withFilters(BlobInventoryPolicyFilter filters)

Set the filters property: An object that defines the filter set.
BlobInventoryPolicyDefinition withFormat(Format format)

Set the format property: This is a required field, it specifies the format for the inventory files.
BlobInventoryPolicyDefinition withObjectType(ObjectType objectType)

Set the objectType property: This is a required field.
BlobInventoryPolicyDefinition withSchedule(Schedule schedule)

Set the schedule property: This is a required field.
BlobInventoryPolicyDefinition withSchemaFields(List<String> schemaFields)

Set the schemaFields property: This is a required field.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

BlobInventoryPolicyDefinition

public BlobInventoryPolicyDefinition()

Creates an instance of BlobInventoryPolicyDefinition class.

Method Details

filters

public BlobInventoryPolicyFilter filters()

Get the filters property: An object that defines the filter set.

Returns:

the filters value.

format

public Format format()

Get the format property: This is a required field, it specifies the format for the inventory files.

Returns:

the format value.

fromJson

public static BlobInventoryPolicyDefinition fromJson(JsonReader jsonReader)

Reads an instance of BlobInventoryPolicyDefinition from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of BlobInventoryPolicyDefinition 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.

objectType

public ObjectType objectType()

Get the objectType property: This is a required field. This field specifies the scope of the inventory created either at the blob or container level.

Returns:

the objectType value.

schedule

public Schedule schedule()

Get the schedule property: This is a required field. This field is used to schedule an inventory formation.

Returns:

the schedule value.

schemaFields

public List schemaFields()

Get the schemaFields property: This is a required field. This field specifies the fields and properties of the object to be included in the inventory. The Schema field value 'Name' is always required. The valid values for this field for the 'Blob' definition.objectType include 'Name, Creation-Time, Last-Modified, Content-Length, Content-MD5, BlobType, AccessTier, AccessTierChangeTime, AccessTierInferred, Tags, Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, Snapshot, VersionId, IsCurrentVersion, Metadata, LastAccessTime, Tags, Etag, ContentType, ContentEncoding, ContentLanguage, ContentCRC64, CacheControl, ContentDisposition, LeaseStatus, LeaseState, LeaseDuration, ServerEncrypted, Deleted, DeletionId, DeletedTime, RemainingRetentionDays, ImmutabilityPolicyUntilDate, ImmutabilityPolicyMode, LegalHold, CopyId, CopyStatus, CopySource, CopyProgress, CopyCompletionTime, CopyStatusDescription, CustomerProvidedKeySha256, RehydratePriority, ArchiveStatus, XmsBlobSequenceNumber, EncryptionScope, IncrementalCopy, TagCount'. For Blob object type schema field value 'DeletedTime' is applicable only for Hns enabled accounts. The valid values for 'Container' definition.objectType include 'Name, Last-Modified, Metadata, LeaseStatus, LeaseState, LeaseDuration, PublicAccess, HasImmutabilityPolicy, HasLegalHold, Etag, DefaultEncryptionScope, DenyEncryptionScopeOverride, ImmutableStorageWithVersioningEnabled, Deleted, Version, DeletedTime, RemainingRetentionDays'. Schema field values 'Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, DeletionId' are valid only for Hns enabled accounts.Schema field values 'Tags, TagCount' are only valid for Non-Hns accounts.

Returns:

the schemaFields value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withFilters

public BlobInventoryPolicyDefinition withFilters(BlobInventoryPolicyFilter filters)

Set the filters property: An object that defines the filter set.

Parameters:

filters - the filters value to set.

Returns:

the BlobInventoryPolicyDefinition object itself.

withFormat

public BlobInventoryPolicyDefinition withFormat(Format format)

Set the format property: This is a required field, it specifies the format for the inventory files.

Parameters:

format - the format value to set.

Returns:

the BlobInventoryPolicyDefinition object itself.

withObjectType

public BlobInventoryPolicyDefinition withObjectType(ObjectType objectType)

Set the objectType property: This is a required field. This field specifies the scope of the inventory created either at the blob or container level.

Parameters:

objectType - the objectType value to set.

Returns:

the BlobInventoryPolicyDefinition object itself.

withSchedule

public BlobInventoryPolicyDefinition withSchedule(Schedule schedule)

Set the schedule property: This is a required field. This field is used to schedule an inventory formation.

Parameters:

schedule - the schedule value to set.

Returns:

the BlobInventoryPolicyDefinition object itself.

withSchemaFields

public BlobInventoryPolicyDefinition withSchemaFields(List schemaFields)

Set the schemaFields property: This is a required field. This field specifies the fields and properties of the object to be included in the inventory. The Schema field value 'Name' is always required. The valid values for this field for the 'Blob' definition.objectType include 'Name, Creation-Time, Last-Modified, Content-Length, Content-MD5, BlobType, AccessTier, AccessTierChangeTime, AccessTierInferred, Tags, Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, Snapshot, VersionId, IsCurrentVersion, Metadata, LastAccessTime, Tags, Etag, ContentType, ContentEncoding, ContentLanguage, ContentCRC64, CacheControl, ContentDisposition, LeaseStatus, LeaseState, LeaseDuration, ServerEncrypted, Deleted, DeletionId, DeletedTime, RemainingRetentionDays, ImmutabilityPolicyUntilDate, ImmutabilityPolicyMode, LegalHold, CopyId, CopyStatus, CopySource, CopyProgress, CopyCompletionTime, CopyStatusDescription, CustomerProvidedKeySha256, RehydratePriority, ArchiveStatus, XmsBlobSequenceNumber, EncryptionScope, IncrementalCopy, TagCount'. For Blob object type schema field value 'DeletedTime' is applicable only for Hns enabled accounts. The valid values for 'Container' definition.objectType include 'Name, Last-Modified, Metadata, LeaseStatus, LeaseState, LeaseDuration, PublicAccess, HasImmutabilityPolicy, HasLegalHold, Etag, DefaultEncryptionScope, DenyEncryptionScopeOverride, ImmutableStorageWithVersioningEnabled, Deleted, Version, DeletedTime, RemainingRetentionDays'. Schema field values 'Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, DeletionId' are valid only for Hns enabled accounts.Schema field values 'Tags, TagCount' are only valid for Non-Hns accounts.

Parameters:

schemaFields - the schemaFields value to set.

Returns:

the BlobInventoryPolicyDefinition object itself.

Applies to