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

236 строки
19 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.storage.blob.options.BlobCopyFromUrlOptions"
fullName: "com.azure.storage.blob.options.BlobCopyFromUrlOptions"
name: "BlobCopyFromUrlOptions"
nameWithType: "BlobCopyFromUrlOptions"
summary: "Extended options that may be passed when copying a 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 **BlobCopyFromUrlOptions**"
constructors:
- uid: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.BlobCopyFromUrlOptions(java.lang.String)"
fullName: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.BlobCopyFromUrlOptions(String copySource)"
name: "BlobCopyFromUrlOptions(String copySource)"
nameWithType: "BlobCopyFromUrlOptions.BlobCopyFromUrlOptions(String copySource)"
parameters:
- description: "The source URL to copy from. URLs outside of Azure may only be copied to block blobs."
name: "copySource"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BlobCopyFromUrlOptions(String copySource)"
methods:
- uid: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.getCopySource()"
fullName: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.getCopySource()"
name: "getCopySource()"
nameWithType: "BlobCopyFromUrlOptions.getCopySource()"
syntax: "public String getCopySource()"
returns:
description: "The source URL to copy from. URLs outside of Azure may only be copied to block blobs."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.getCopySourceTagsMode()"
fullName: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.getCopySourceTagsMode()"
name: "getCopySourceTagsMode()"
nameWithType: "BlobCopyFromUrlOptions.getCopySourceTagsMode()"
syntax: "public BlobCopySourceTagsMode getCopySourceTagsMode()"
returns:
description: "The copy source tags mode."
type: "<xref href=\"com.azure.storage.blob.models.BlobCopySourceTagsMode?alt=com.azure.storage.blob.models.BlobCopySourceTagsMode&text=BlobCopySourceTagsMode\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.getDestinationRequestConditions()"
fullName: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.getDestinationRequestConditions()"
name: "getDestinationRequestConditions()"
nameWithType: "BlobCopyFromUrlOptions.getDestinationRequestConditions()"
syntax: "public BlobRequestConditions getDestinationRequestConditions()"
returns:
description: "<xref uid=\"com.azure.storage.blob.models.BlobRequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobRequestConditions\"></xref> for the destination."
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.BlobCopyFromUrlOptions.getImmutabilityPolicy()"
fullName: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.getImmutabilityPolicy()"
name: "getImmutabilityPolicy()"
nameWithType: "BlobCopyFromUrlOptions.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.BlobCopyFromUrlOptions.getMetadata()"
fullName: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.getMetadata()"
name: "getMetadata()"
nameWithType: "BlobCopyFromUrlOptions.getMetadata()"
syntax: "public Map<String,String> getMetadata()"
returns:
description: "The metadata to associate with the destination 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.BlobCopyFromUrlOptions.getSourceAuthorization()"
fullName: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.getSourceAuthorization()"
name: "getSourceAuthorization()"
nameWithType: "BlobCopyFromUrlOptions.getSourceAuthorization()"
syntax: "public HttpAuthorization getSourceAuthorization()"
returns:
description: "auth header for access to source."
type: "<xref href=\"com.azure.core.http.HttpAuthorization?alt=com.azure.core.http.HttpAuthorization&text=HttpAuthorization\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.getSourceRequestConditions()"
fullName: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.getSourceRequestConditions()"
name: "getSourceRequestConditions()"
nameWithType: "BlobCopyFromUrlOptions.getSourceRequestConditions()"
syntax: "public RequestConditions getSourceRequestConditions()"
returns:
description: "<xref uid=\"com.azure.core.http.RequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RequestConditions\"></xref> for the source."
type: "<xref href=\"com.azure.core.http.RequestConditions?alt=com.azure.core.http.RequestConditions&text=RequestConditions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.getTags()"
fullName: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.getTags()"
name: "getTags()"
nameWithType: "BlobCopyFromUrlOptions.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.BlobCopyFromUrlOptions.getTier()"
fullName: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.getTier()"
name: "getTier()"
nameWithType: "BlobCopyFromUrlOptions.getTier()"
syntax: "public AccessTier getTier()"
returns:
description: "<xref uid=\"com.azure.storage.blob.models.AccessTier\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccessTier\"></xref> for the destination blob."
type: "<xref href=\"com.azure.storage.blob.models.AccessTier?alt=com.azure.storage.blob.models.AccessTier&text=AccessTier\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.hasLegalHold()"
fullName: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.hasLegalHold()"
name: "hasLegalHold()"
nameWithType: "BlobCopyFromUrlOptions.hasLegalHold()"
syntax: "public Boolean hasLegalHold()"
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.BlobCopyFromUrlOptions.setCopySourceTagsMode(com.azure.storage.blob.models.BlobCopySourceTagsMode)"
fullName: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.setCopySourceTagsMode(BlobCopySourceTagsMode copySourceTags)"
name: "setCopySourceTagsMode(BlobCopySourceTagsMode copySourceTags)"
nameWithType: "BlobCopyFromUrlOptions.setCopySourceTagsMode(BlobCopySourceTagsMode copySourceTags)"
summary: "Sets the copy source tags mode"
parameters:
- description: "Indicates if a legal hold should be placed on the blob."
name: "copySourceTags"
type: "<xref href=\"com.azure.storage.blob.models.BlobCopySourceTagsMode?alt=com.azure.storage.blob.models.BlobCopySourceTagsMode&text=BlobCopySourceTagsMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public BlobCopyFromUrlOptions setCopySourceTagsMode(BlobCopySourceTagsMode copySourceTags)"
desc: "Sets the copy source tags mode"
returns:
description: "The updated options."
type: "<xref href=\"com.azure.storage.blob.options.BlobCopyFromUrlOptions?alt=com.azure.storage.blob.options.BlobCopyFromUrlOptions&text=BlobCopyFromUrlOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.setDestinationRequestConditions(com.azure.storage.blob.models.BlobRequestConditions)"
fullName: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.setDestinationRequestConditions(BlobRequestConditions destinationRequestConditions)"
name: "setDestinationRequestConditions(BlobRequestConditions destinationRequestConditions)"
nameWithType: "BlobCopyFromUrlOptions.setDestinationRequestConditions(BlobRequestConditions destinationRequestConditions)"
parameters:
- description: "<xref uid=\"com.azure.storage.blob.models.BlobRequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobRequestConditions\"></xref> for the destination."
name: "destinationRequestConditions"
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 BlobCopyFromUrlOptions setDestinationRequestConditions(BlobRequestConditions destinationRequestConditions)"
returns:
description: "The updated options."
type: "<xref href=\"com.azure.storage.blob.options.BlobCopyFromUrlOptions?alt=com.azure.storage.blob.options.BlobCopyFromUrlOptions&text=BlobCopyFromUrlOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.setImmutabilityPolicy(com.azure.storage.blob.models.BlobImmutabilityPolicy)"
fullName: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.setImmutabilityPolicy(BlobImmutabilityPolicy immutabilityPolicy)"
name: "setImmutabilityPolicy(BlobImmutabilityPolicy immutabilityPolicy)"
nameWithType: "BlobCopyFromUrlOptions.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 BlobCopyFromUrlOptions 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.BlobCopyFromUrlOptions?alt=com.azure.storage.blob.options.BlobCopyFromUrlOptions&text=BlobCopyFromUrlOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.setLegalHold(java.lang.Boolean)"
fullName: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.setLegalHold(Boolean legalHold)"
name: "setLegalHold(Boolean legalHold)"
nameWithType: "BlobCopyFromUrlOptions.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 BlobCopyFromUrlOptions 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.BlobCopyFromUrlOptions?alt=com.azure.storage.blob.options.BlobCopyFromUrlOptions&text=BlobCopyFromUrlOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.setMetadata(java.util.Map<java.lang.String,java.lang.String>)"
fullName: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.setMetadata(Map<String,String> metadata)"
name: "setMetadata(Map<String,String> metadata)"
nameWithType: "BlobCopyFromUrlOptions.setMetadata(Map<String,String> metadata)"
parameters:
- description: "The metadata to associate with the destination 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 BlobCopyFromUrlOptions setMetadata(Map<String,String> metadata)"
returns:
description: "The updated options"
type: "<xref href=\"com.azure.storage.blob.options.BlobCopyFromUrlOptions?alt=com.azure.storage.blob.options.BlobCopyFromUrlOptions&text=BlobCopyFromUrlOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.setSourceAuthorization(com.azure.core.http.HttpAuthorization)"
fullName: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.setSourceAuthorization(HttpAuthorization sourceAuthorization)"
name: "setSourceAuthorization(HttpAuthorization sourceAuthorization)"
nameWithType: "BlobCopyFromUrlOptions.setSourceAuthorization(HttpAuthorization sourceAuthorization)"
summary: "Sets \"Authorization\" header for accessing source URL."
parameters:
- description: "auth header for access to source."
name: "sourceAuthorization"
type: "<xref href=\"com.azure.core.http.HttpAuthorization?alt=com.azure.core.http.HttpAuthorization&text=HttpAuthorization\" data-throw-if-not-resolved=\"False\" />"
syntax: "public BlobCopyFromUrlOptions setSourceAuthorization(HttpAuthorization sourceAuthorization)"
desc: "Sets \"Authorization\" header for accessing source URL. Currently only \"Bearer\" authentication is accepted by Storage."
returns:
description: "The updated options."
type: "<xref href=\"com.azure.storage.blob.options.BlobCopyFromUrlOptions?alt=com.azure.storage.blob.options.BlobCopyFromUrlOptions&text=BlobCopyFromUrlOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.setSourceRequestConditions(com.azure.core.http.RequestConditions)"
fullName: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.setSourceRequestConditions(RequestConditions sourceRequestConditions)"
name: "setSourceRequestConditions(RequestConditions sourceRequestConditions)"
nameWithType: "BlobCopyFromUrlOptions.setSourceRequestConditions(RequestConditions sourceRequestConditions)"
parameters:
- description: "<xref uid=\"com.azure.core.http.RequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RequestConditions\"></xref> for the source."
name: "sourceRequestConditions"
type: "<xref href=\"com.azure.core.http.RequestConditions?alt=com.azure.core.http.RequestConditions&text=RequestConditions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public BlobCopyFromUrlOptions setSourceRequestConditions(RequestConditions sourceRequestConditions)"
returns:
description: "The updated options."
type: "<xref href=\"com.azure.storage.blob.options.BlobCopyFromUrlOptions?alt=com.azure.storage.blob.options.BlobCopyFromUrlOptions&text=BlobCopyFromUrlOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.setTags(java.util.Map<java.lang.String,java.lang.String>)"
fullName: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.setTags(Map<String,String> tags)"
name: "setTags(Map<String,String> tags)"
nameWithType: "BlobCopyFromUrlOptions.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 BlobCopyFromUrlOptions setTags(Map<String,String> tags)"
returns:
description: "The updated options."
type: "<xref href=\"com.azure.storage.blob.options.BlobCopyFromUrlOptions?alt=com.azure.storage.blob.options.BlobCopyFromUrlOptions&text=BlobCopyFromUrlOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.setTier(com.azure.storage.blob.models.AccessTier)"
fullName: "com.azure.storage.blob.options.BlobCopyFromUrlOptions.setTier(AccessTier tier)"
name: "setTier(AccessTier tier)"
nameWithType: "BlobCopyFromUrlOptions.setTier(AccessTier tier)"
parameters:
- description: "<xref uid=\"com.azure.storage.blob.models.AccessTier\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccessTier\"></xref> for the destination blob."
name: "tier"
type: "<xref href=\"com.azure.storage.blob.models.AccessTier?alt=com.azure.storage.blob.models.AccessTier&text=AccessTier\" data-throw-if-not-resolved=\"False\" />"
syntax: "public BlobCopyFromUrlOptions setTier(AccessTier tier)"
returns:
description: "The updated options."
type: "<xref href=\"com.azure.storage.blob.options.BlobCopyFromUrlOptions?alt=com.azure.storage.blob.options.BlobCopyFromUrlOptions&text=BlobCopyFromUrlOptions\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Extended options that may be passed when copying a blob."
metadata: {}
package: "com.azure.storage.blob.options"
artifact: com.azure:azure-storage-blob:12.28.1