Class BlobInventoryPolicyFilter

java.lang.Object
com.azure.resourcemanager.storage.models.BlobInventoryPolicyFilter
All Implemented Interfaces:
com.azure.json.JsonSerializable<BlobInventoryPolicyFilter>
public final class BlobInventoryPolicyFilter extends Object implements com.azure.json.JsonSerializable<BlobInventoryPolicyFilter>
An object that defines the blob inventory rule filter conditions. For 'Blob' definition.objectType all filter properties are applicable, 'blobTypes' is required and others are optional. For 'Container' definition.objectType only prefixMatch is applicable and is optional.

  • Constructor Details

    • BlobInventoryPolicyFilter

      public BlobInventoryPolicyFilter()
      Creates an instance of BlobInventoryPolicyFilter class.

  • Method Details

    • prefixMatch

      public List<String> prefixMatch()
      Get the prefixMatch property: An array of strings with maximum 10 blob prefixes to be included in the inventory.
      Returns:
      the prefixMatch value.

    • withPrefixMatch

      public BlobInventoryPolicyFilter withPrefixMatch(List<String> prefixMatch)
      Set the prefixMatch property: An array of strings with maximum 10 blob prefixes to be included in the inventory.
      Parameters:
      prefixMatch - the prefixMatch value to set.
      Returns:
      the BlobInventoryPolicyFilter object itself.

    • excludePrefix

      public List<String> excludePrefix()
      Get the excludePrefix property: An array of strings with maximum 10 blob prefixes to be excluded from the inventory.
      Returns:
      the excludePrefix value.

    • withExcludePrefix

      public BlobInventoryPolicyFilter withExcludePrefix(List<String> excludePrefix)
      Set the excludePrefix property: An array of strings with maximum 10 blob prefixes to be excluded from the inventory.
      Parameters:
      excludePrefix - the excludePrefix value to set.
      Returns:
      the BlobInventoryPolicyFilter object itself.

    • blobTypes

      public List<String> blobTypes()
      Get the blobTypes property: An array of predefined enum values. Valid values include blockBlob, appendBlob, pageBlob. Hns accounts does not support pageBlobs. This field is required when definition.objectType property is set to 'Blob'.
      Returns:
      the blobTypes value.

    • withBlobTypes

      public BlobInventoryPolicyFilter withBlobTypes(List<String> blobTypes)
      Set the blobTypes property: An array of predefined enum values. Valid values include blockBlob, appendBlob, pageBlob. Hns accounts does not support pageBlobs. This field is required when definition.objectType property is set to 'Blob'.
      Parameters:
      blobTypes - the blobTypes value to set.
      Returns:
      the BlobInventoryPolicyFilter object itself.

    • includeBlobVersions

      public Boolean includeBlobVersions()
      Get the includeBlobVersions property: Includes blob versions in blob inventory when value is set to true. The definition.schemaFields values 'VersionId and IsCurrentVersion' are required if this property is set to true, else they must be excluded.
      Returns:
      the includeBlobVersions value.

    • withIncludeBlobVersions

      public BlobInventoryPolicyFilter withIncludeBlobVersions(Boolean includeBlobVersions)
      Set the includeBlobVersions property: Includes blob versions in blob inventory when value is set to true. The definition.schemaFields values 'VersionId and IsCurrentVersion' are required if this property is set to true, else they must be excluded.
      Parameters:
      includeBlobVersions - the includeBlobVersions value to set.
      Returns:
      the BlobInventoryPolicyFilter object itself.

    • includeSnapshots

      public Boolean includeSnapshots()
      Get the includeSnapshots property: Includes blob snapshots in blob inventory when value is set to true. The definition.schemaFields value 'Snapshot' is required if this property is set to true, else it must be excluded.
      Returns:
      the includeSnapshots value.

    • withIncludeSnapshots

      public BlobInventoryPolicyFilter withIncludeSnapshots(Boolean includeSnapshots)
      Set the includeSnapshots property: Includes blob snapshots in blob inventory when value is set to true. The definition.schemaFields value 'Snapshot' is required if this property is set to true, else it must be excluded.
      Parameters:
      includeSnapshots - the includeSnapshots value to set.
      Returns:
      the BlobInventoryPolicyFilter object itself.

    • includeDeleted

      public Boolean includeDeleted()
      Get the includeDeleted property: For 'Container' definition.objectType the definition.schemaFields must include 'Deleted, Version, DeletedTime and RemainingRetentionDays'. For 'Blob' definition.objectType and HNS enabled storage accounts the definition.schemaFields must include 'DeletionId, Deleted, DeletedTime and RemainingRetentionDays' and for Hns disabled accounts the definition.schemaFields must include 'Deleted and RemainingRetentionDays', else it must be excluded.
      Returns:
      the includeDeleted value.

    • withIncludeDeleted

      public BlobInventoryPolicyFilter withIncludeDeleted(Boolean includeDeleted)
      Set the includeDeleted property: For 'Container' definition.objectType the definition.schemaFields must include 'Deleted, Version, DeletedTime and RemainingRetentionDays'. For 'Blob' definition.objectType and HNS enabled storage accounts the definition.schemaFields must include 'DeletionId, Deleted, DeletedTime and RemainingRetentionDays' and for Hns disabled accounts the definition.schemaFields must include 'Deleted and RemainingRetentionDays', else it must be excluded.
      Parameters:
      includeDeleted - the includeDeleted value to set.
      Returns:
      the BlobInventoryPolicyFilter object itself.

    • creationTime

      public BlobInventoryCreationTime creationTime()
      Get the creationTime property: This property is used to filter objects based on the object creation time.
      Returns:
      the creationTime value.

    • withCreationTime

      public BlobInventoryPolicyFilter withCreationTime(BlobInventoryCreationTime creationTime)
      Set the creationTime property: This property is used to filter objects based on the object creation time.
      Parameters:
      creationTime - the creationTime value to set.
      Returns:
      the BlobInventoryPolicyFilter object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<BlobInventoryPolicyFilter>
      Throws:
      IOException

    • fromJson

      public static BlobInventoryPolicyFilter fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of BlobInventoryPolicyFilter from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of BlobInventoryPolicyFilter if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the BlobInventoryPolicyFilter.