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

192 строки
15 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.storage.blob.options.PageBlobCreateOptions"
fullName: "com.azure.storage.blob.options.PageBlobCreateOptions"
name: "PageBlobCreateOptions"
nameWithType: "PageBlobCreateOptions"
summary: "Extended options that may be passed when creating a Page 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 **PageBlobCreateOptions**"
constructors:
- uid: "com.azure.storage.blob.options.PageBlobCreateOptions.PageBlobCreateOptions(long)"
fullName: "com.azure.storage.blob.options.PageBlobCreateOptions.PageBlobCreateOptions(long size)"
name: "PageBlobCreateOptions(long size)"
nameWithType: "PageBlobCreateOptions.PageBlobCreateOptions(long size)"
parameters:
- description: "Specifies the maximum size for the page blob, up to 8 TB. The page blob size must be aligned to a\n 512-byte boundary."
name: "size"
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PageBlobCreateOptions(long size)"
methods:
- uid: "com.azure.storage.blob.options.PageBlobCreateOptions.getHeaders()"
fullName: "com.azure.storage.blob.options.PageBlobCreateOptions.getHeaders()"
name: "getHeaders()"
nameWithType: "PageBlobCreateOptions.getHeaders()"
syntax: "public BlobHttpHeaders getHeaders()"
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.PageBlobCreateOptions.getImmutabilityPolicy()"
fullName: "com.azure.storage.blob.options.PageBlobCreateOptions.getImmutabilityPolicy()"
name: "getImmutabilityPolicy()"
nameWithType: "PageBlobCreateOptions.getImmutabilityPolicy()"
syntax: "public BlobImmutabilityPolicy getImmutabilityPolicy()"
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.PageBlobCreateOptions.getMetadata()"
fullName: "com.azure.storage.blob.options.PageBlobCreateOptions.getMetadata()"
name: "getMetadata()"
nameWithType: "PageBlobCreateOptions.getMetadata()"
syntax: "public Map<String,String> getMetadata()"
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.PageBlobCreateOptions.getRequestConditions()"
fullName: "com.azure.storage.blob.options.PageBlobCreateOptions.getRequestConditions()"
name: "getRequestConditions()"
nameWithType: "PageBlobCreateOptions.getRequestConditions()"
syntax: "public BlobRequestConditions getRequestConditions()"
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.PageBlobCreateOptions.getSequenceNumber()"
fullName: "com.azure.storage.blob.options.PageBlobCreateOptions.getSequenceNumber()"
name: "getSequenceNumber()"
nameWithType: "PageBlobCreateOptions.getSequenceNumber()"
syntax: "public Long getSequenceNumber()"
returns:
description: "A user-controlled value that you can use to track requests. The value of the sequence\n number must be between 0 and 2^63 - 1.The default value is 0."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
- uid: "com.azure.storage.blob.options.PageBlobCreateOptions.getSize()"
fullName: "com.azure.storage.blob.options.PageBlobCreateOptions.getSize()"
name: "getSize()"
nameWithType: "PageBlobCreateOptions.getSize()"
syntax: "public long getSize()"
returns:
description: "Specifies the maximum size for the page blob, up to 8 TB. The page blob size must be aligned to a\n 512-byte boundary."
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.PageBlobCreateOptions.getTags()"
fullName: "com.azure.storage.blob.options.PageBlobCreateOptions.getTags()"
name: "getTags()"
nameWithType: "PageBlobCreateOptions.getTags()"
syntax: "public Map<String,String> getTags()"
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.PageBlobCreateOptions.isLegalHold()"
fullName: "com.azure.storage.blob.options.PageBlobCreateOptions.isLegalHold()"
name: "isLegalHold()"
nameWithType: "PageBlobCreateOptions.isLegalHold()"
syntax: "public Boolean isLegalHold()"
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.PageBlobCreateOptions.setHeaders(com.azure.storage.blob.models.BlobHttpHeaders)"
fullName: "com.azure.storage.blob.options.PageBlobCreateOptions.setHeaders(BlobHttpHeaders headers)"
name: "setHeaders(BlobHttpHeaders headers)"
nameWithType: "PageBlobCreateOptions.setHeaders(BlobHttpHeaders headers)"
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 PageBlobCreateOptions setHeaders(BlobHttpHeaders headers)"
returns:
description: "The updated <code>AppendBlobCreateOptions</code>"
type: "<xref href=\"com.azure.storage.blob.options.PageBlobCreateOptions?alt=com.azure.storage.blob.options.PageBlobCreateOptions&text=PageBlobCreateOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.PageBlobCreateOptions.setImmutabilityPolicy(com.azure.storage.blob.models.BlobImmutabilityPolicy)"
fullName: "com.azure.storage.blob.options.PageBlobCreateOptions.setImmutabilityPolicy(BlobImmutabilityPolicy immutabilityPolicy)"
name: "setImmutabilityPolicy(BlobImmutabilityPolicy immutabilityPolicy)"
nameWithType: "PageBlobCreateOptions.setImmutabilityPolicy(BlobImmutabilityPolicy immutabilityPolicy)"
summary: "Note that this parameter is only applicable to a blob within a container that has immutable storage with versioning enabled."
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 PageBlobCreateOptions setImmutabilityPolicy(BlobImmutabilityPolicy immutabilityPolicy)"
desc: "Note 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.PageBlobCreateOptions?alt=com.azure.storage.blob.options.PageBlobCreateOptions&text=PageBlobCreateOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.PageBlobCreateOptions.setLegalHold(java.lang.Boolean)"
fullName: "com.azure.storage.blob.options.PageBlobCreateOptions.setLegalHold(Boolean legalHold)"
name: "setLegalHold(Boolean legalHold)"
nameWithType: "PageBlobCreateOptions.setLegalHold(Boolean legalHold)"
summary: "Note that this parameter is only applicable to a blob within a container that has immutable storage with versioning enabled."
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 PageBlobCreateOptions setLegalHold(Boolean legalHold)"
desc: "Note 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.PageBlobCreateOptions?alt=com.azure.storage.blob.options.PageBlobCreateOptions&text=PageBlobCreateOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.PageBlobCreateOptions.setMetadata(java.util.Map<java.lang.String,java.lang.String>)"
fullName: "com.azure.storage.blob.options.PageBlobCreateOptions.setMetadata(Map<String,String> metadata)"
name: "setMetadata(Map<String,String> metadata)"
nameWithType: "PageBlobCreateOptions.setMetadata(Map<String,String> metadata)"
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 PageBlobCreateOptions setMetadata(Map<String,String> metadata)"
returns:
description: "The updated options."
type: "<xref href=\"com.azure.storage.blob.options.PageBlobCreateOptions?alt=com.azure.storage.blob.options.PageBlobCreateOptions&text=PageBlobCreateOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.PageBlobCreateOptions.setRequestConditions(com.azure.storage.blob.models.BlobRequestConditions)"
fullName: "com.azure.storage.blob.options.PageBlobCreateOptions.setRequestConditions(BlobRequestConditions requestConditions)"
name: "setRequestConditions(BlobRequestConditions requestConditions)"
nameWithType: "PageBlobCreateOptions.setRequestConditions(BlobRequestConditions requestConditions)"
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 PageBlobCreateOptions setRequestConditions(BlobRequestConditions requestConditions)"
returns:
description: "The updated options."
type: "<xref href=\"com.azure.storage.blob.options.PageBlobCreateOptions?alt=com.azure.storage.blob.options.PageBlobCreateOptions&text=PageBlobCreateOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.PageBlobCreateOptions.setSequenceNumber(java.lang.Long)"
fullName: "com.azure.storage.blob.options.PageBlobCreateOptions.setSequenceNumber(Long sequenceNumber)"
name: "setSequenceNumber(Long sequenceNumber)"
nameWithType: "PageBlobCreateOptions.setSequenceNumber(Long sequenceNumber)"
parameters:
- description: "A user-controlled value that you can use to track requests. The value of the sequence\n number must be between 0 and 2^63 - 1.The default value is 0."
name: "sequenceNumber"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
syntax: "public PageBlobCreateOptions setSequenceNumber(Long sequenceNumber)"
returns:
description: "The updated options."
type: "<xref href=\"com.azure.storage.blob.options.PageBlobCreateOptions?alt=com.azure.storage.blob.options.PageBlobCreateOptions&text=PageBlobCreateOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.PageBlobCreateOptions.setTags(java.util.Map<java.lang.String,java.lang.String>)"
fullName: "com.azure.storage.blob.options.PageBlobCreateOptions.setTags(Map<String,String> tags)"
name: "setTags(Map<String,String> tags)"
nameWithType: "PageBlobCreateOptions.setTags(Map<String,String> tags)"
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 PageBlobCreateOptions setTags(Map<String,String> tags)"
returns:
description: "The updated options."
type: "<xref href=\"com.azure.storage.blob.options.PageBlobCreateOptions?alt=com.azure.storage.blob.options.PageBlobCreateOptions&text=PageBlobCreateOptions\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Extended options that may be passed when creating a Page Blob."
metadata: {}
package: "com.azure.storage.blob.options"
artifact: com.azure:azure-storage-blob:12.28.1