azure-docs-sdk-java/docs-ref-autogen/com.azure.storage.blob.opti...

182 строки
15 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.storage.blob.options.AppendBlobCreateOptions"
fullName: "com.azure.storage.blob.options.AppendBlobCreateOptions"
name: "AppendBlobCreateOptions"
nameWithType: "AppendBlobCreateOptions"
summary: "Extended options that may be passed when creating an Append Blob."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public class **AppendBlobCreateOptions**"
constructors:
- uid: "com.azure.storage.blob.options.AppendBlobCreateOptions.AppendBlobCreateOptions()"
fullName: "com.azure.storage.blob.options.AppendBlobCreateOptions.AppendBlobCreateOptions()"
name: "AppendBlobCreateOptions()"
nameWithType: "AppendBlobCreateOptions.AppendBlobCreateOptions()"
summary: "Creates a new instance of <xref uid=\"com.azure.storage.blob.options.AppendBlobCreateOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AppendBlobCreateOptions\"></xref>."
syntax: "public AppendBlobCreateOptions()"
desc: "Creates a new instance of <xref uid=\"com.azure.storage.blob.options.AppendBlobCreateOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AppendBlobCreateOptions\"></xref>."
methods:
- uid: "com.azure.storage.blob.options.AppendBlobCreateOptions.getHeaders()"
fullName: "com.azure.storage.blob.options.AppendBlobCreateOptions.getHeaders()"
name: "getHeaders()"
nameWithType: "AppendBlobCreateOptions.getHeaders()"
summary: "Gets the <xref uid=\"com.azure.storage.blob.models.BlobHttpHeaders\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobHttpHeaders\"></xref>."
syntax: "public BlobHttpHeaders getHeaders()"
desc: "Gets the <xref uid=\"com.azure.storage.blob.models.BlobHttpHeaders\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobHttpHeaders\"></xref>."
returns:
description: "<xref uid=\"com.azure.storage.blob.models.BlobHttpHeaders\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobHttpHeaders\"></xref>"
type: "<xref href=\"com.azure.storage.blob.models.BlobHttpHeaders?alt=com.azure.storage.blob.models.BlobHttpHeaders&text=BlobHttpHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.AppendBlobCreateOptions.getImmutabilityPolicy()"
fullName: "com.azure.storage.blob.options.AppendBlobCreateOptions.getImmutabilityPolicy()"
name: "getImmutabilityPolicy()"
nameWithType: "AppendBlobCreateOptions.getImmutabilityPolicy()"
summary: "Gets the immutability policy for the blob."
syntax: "public BlobImmutabilityPolicy getImmutabilityPolicy()"
desc: "Gets the immutability policy for the blob."
returns:
description: "<xref uid=\"com.azure.storage.blob.models.BlobImmutabilityPolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobImmutabilityPolicy\"></xref>"
type: "<xref href=\"com.azure.storage.blob.models.BlobImmutabilityPolicy?alt=com.azure.storage.blob.models.BlobImmutabilityPolicy&text=BlobImmutabilityPolicy\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.AppendBlobCreateOptions.getMetadata()"
fullName: "com.azure.storage.blob.options.AppendBlobCreateOptions.getMetadata()"
name: "getMetadata()"
nameWithType: "AppendBlobCreateOptions.getMetadata()"
summary: "Gets the metadata to associate with the blob."
syntax: "public Map<String,String> getMetadata()"
desc: "Gets the metadata to associate with the blob."
returns:
description: "The metadata to associate with the blob."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- uid: "com.azure.storage.blob.options.AppendBlobCreateOptions.getRequestConditions()"
fullName: "com.azure.storage.blob.options.AppendBlobCreateOptions.getRequestConditions()"
name: "getRequestConditions()"
nameWithType: "AppendBlobCreateOptions.getRequestConditions()"
summary: "Gets the <xref uid=\"com.azure.storage.blob.models.BlobRequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobRequestConditions\"></xref>."
syntax: "public BlobRequestConditions getRequestConditions()"
desc: "Gets the <xref uid=\"com.azure.storage.blob.models.BlobRequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobRequestConditions\"></xref>."
returns:
description: "<xref uid=\"com.azure.storage.blob.models.BlobRequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobRequestConditions\"></xref>"
type: "<xref href=\"com.azure.storage.blob.models.BlobRequestConditions?alt=com.azure.storage.blob.models.BlobRequestConditions&text=BlobRequestConditions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.AppendBlobCreateOptions.getTags()"
fullName: "com.azure.storage.blob.options.AppendBlobCreateOptions.getTags()"
name: "getTags()"
nameWithType: "AppendBlobCreateOptions.getTags()"
summary: "Gets the tags to associate with the blob."
syntax: "public Map<String,String> getTags()"
desc: "Gets the tags to associate with the blob."
returns:
description: "The tags to associate with the blob."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- uid: "com.azure.storage.blob.options.AppendBlobCreateOptions.hasLegalHold()"
fullName: "com.azure.storage.blob.options.AppendBlobCreateOptions.hasLegalHold()"
name: "hasLegalHold()"
nameWithType: "AppendBlobCreateOptions.hasLegalHold()"
summary: "Gets if a legal hold should be placed on the blob."
syntax: "public Boolean hasLegalHold()"
desc: "Gets if a legal hold should be placed on the blob."
returns:
description: "If a legal hold should be placed on the blob."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.storage.blob.options.AppendBlobCreateOptions.setHeaders(com.azure.storage.blob.models.BlobHttpHeaders)"
fullName: "com.azure.storage.blob.options.AppendBlobCreateOptions.setHeaders(BlobHttpHeaders headers)"
name: "setHeaders(BlobHttpHeaders headers)"
nameWithType: "AppendBlobCreateOptions.setHeaders(BlobHttpHeaders headers)"
summary: "Sets the <xref uid=\"com.azure.storage.blob.models.BlobHttpHeaders\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobHttpHeaders\"></xref>."
parameters:
- description: "<xref uid=\"com.azure.storage.blob.models.BlobHttpHeaders\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobHttpHeaders\"></xref>"
name: "headers"
type: "<xref href=\"com.azure.storage.blob.models.BlobHttpHeaders?alt=com.azure.storage.blob.models.BlobHttpHeaders&text=BlobHttpHeaders\" data-throw-if-not-resolved=\"False\" />"
syntax: "public AppendBlobCreateOptions setHeaders(BlobHttpHeaders headers)"
desc: "Sets the <xref uid=\"com.azure.storage.blob.models.BlobHttpHeaders\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobHttpHeaders\"></xref>."
returns:
description: "The updated <code>AppendBlobCreateOptions</code>"
type: "<xref href=\"com.azure.storage.blob.options.AppendBlobCreateOptions?alt=com.azure.storage.blob.options.AppendBlobCreateOptions&text=AppendBlobCreateOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.AppendBlobCreateOptions.setImmutabilityPolicy(com.azure.storage.blob.models.BlobImmutabilityPolicy)"
fullName: "com.azure.storage.blob.options.AppendBlobCreateOptions.setImmutabilityPolicy(BlobImmutabilityPolicy immutabilityPolicy)"
name: "setImmutabilityPolicy(BlobImmutabilityPolicy immutabilityPolicy)"
nameWithType: "AppendBlobCreateOptions.setImmutabilityPolicy(BlobImmutabilityPolicy immutabilityPolicy)"
summary: "Sets the immutability policy for the blob."
parameters:
- description: "<xref uid=\"com.azure.storage.blob.models.BlobImmutabilityPolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobImmutabilityPolicy\"></xref>"
name: "immutabilityPolicy"
type: "<xref href=\"com.azure.storage.blob.models.BlobImmutabilityPolicy?alt=com.azure.storage.blob.models.BlobImmutabilityPolicy&text=BlobImmutabilityPolicy\" data-throw-if-not-resolved=\"False\" />"
syntax: "public AppendBlobCreateOptions setImmutabilityPolicy(BlobImmutabilityPolicy immutabilityPolicy)"
desc: "Sets the immutability policy for the blob.\n\nNote that this parameter is only applicable to a blob within a container that has immutable storage with versioning enabled."
returns:
description: "The updated options."
type: "<xref href=\"com.azure.storage.blob.options.AppendBlobCreateOptions?alt=com.azure.storage.blob.options.AppendBlobCreateOptions&text=AppendBlobCreateOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.AppendBlobCreateOptions.setLegalHold(java.lang.Boolean)"
fullName: "com.azure.storage.blob.options.AppendBlobCreateOptions.setLegalHold(Boolean legalHold)"
name: "setLegalHold(Boolean legalHold)"
nameWithType: "AppendBlobCreateOptions.setLegalHold(Boolean legalHold)"
summary: "Sets if a legal hold should be placed on the blob."
parameters:
- description: "Indicates if a legal hold should be placed on the blob."
name: "legalHold"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public AppendBlobCreateOptions setLegalHold(Boolean legalHold)"
desc: "Sets if a legal hold should be placed on the blob.\n\nNote that this parameter is only applicable to a blob within a container that has immutable storage with versioning enabled."
returns:
description: "The updated options."
type: "<xref href=\"com.azure.storage.blob.options.AppendBlobCreateOptions?alt=com.azure.storage.blob.options.AppendBlobCreateOptions&text=AppendBlobCreateOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.AppendBlobCreateOptions.setMetadata(java.util.Map<java.lang.String,java.lang.String>)"
fullName: "com.azure.storage.blob.options.AppendBlobCreateOptions.setMetadata(Map<String,String> metadata)"
name: "setMetadata(Map<String,String> metadata)"
nameWithType: "AppendBlobCreateOptions.setMetadata(Map<String,String> metadata)"
summary: "Sets the metadata to associate with the blob."
parameters:
- description: "The metadata to associate with the blob."
name: "metadata"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
syntax: "public AppendBlobCreateOptions setMetadata(Map<String,String> metadata)"
desc: "Sets the metadata to associate with the blob."
returns:
description: "The updated options"
type: "<xref href=\"com.azure.storage.blob.options.AppendBlobCreateOptions?alt=com.azure.storage.blob.options.AppendBlobCreateOptions&text=AppendBlobCreateOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.AppendBlobCreateOptions.setRequestConditions(com.azure.storage.blob.models.BlobRequestConditions)"
fullName: "com.azure.storage.blob.options.AppendBlobCreateOptions.setRequestConditions(BlobRequestConditions requestConditions)"
name: "setRequestConditions(BlobRequestConditions requestConditions)"
nameWithType: "AppendBlobCreateOptions.setRequestConditions(BlobRequestConditions requestConditions)"
summary: "Sets the <xref uid=\"com.azure.storage.blob.models.BlobRequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobRequestConditions\"></xref>."
parameters:
- description: "<xref uid=\"com.azure.storage.blob.models.BlobRequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobRequestConditions\"></xref>"
name: "requestConditions"
type: "<xref href=\"com.azure.storage.blob.models.BlobRequestConditions?alt=com.azure.storage.blob.models.BlobRequestConditions&text=BlobRequestConditions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public AppendBlobCreateOptions setRequestConditions(BlobRequestConditions requestConditions)"
desc: "Sets the <xref uid=\"com.azure.storage.blob.models.BlobRequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobRequestConditions\"></xref>."
returns:
description: "The updated options."
type: "<xref href=\"com.azure.storage.blob.options.AppendBlobCreateOptions?alt=com.azure.storage.blob.options.AppendBlobCreateOptions&text=AppendBlobCreateOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.AppendBlobCreateOptions.setTags(java.util.Map<java.lang.String,java.lang.String>)"
fullName: "com.azure.storage.blob.options.AppendBlobCreateOptions.setTags(Map<String,String> tags)"
name: "setTags(Map<String,String> tags)"
nameWithType: "AppendBlobCreateOptions.setTags(Map<String,String> tags)"
summary: "Sets the tags to associate with the blob."
parameters:
- description: "The tags to associate with the blob."
name: "tags"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
syntax: "public AppendBlobCreateOptions setTags(Map<String,String> tags)"
desc: "Sets the tags to associate with the blob."
returns:
description: "The updated options."
type: "<xref href=\"com.azure.storage.blob.options.AppendBlobCreateOptions?alt=com.azure.storage.blob.options.AppendBlobCreateOptions&text=AppendBlobCreateOptions\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Extended options that may be passed when creating an Append Blob."
metadata: {}
package: "com.azure.storage.blob.options"
artifact: com.azure:azure-storage-blob:12.27.1