azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.b...

246 строки
22 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.batch.models.ResourceFile"
fullName: "com.azure.resourcemanager.batch.models.ResourceFile"
name: "ResourceFile"
nameWithType: "ResourceFile"
summary: "A single file or multiple files to be downloaded to a compute node."
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 final class **ResourceFile**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.batch.models.ResourceFile?alt=com.azure.resourcemanager.batch.models.ResourceFile&text=ResourceFile\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.resourcemanager.batch.models.ResourceFile.ResourceFile()"
fullName: "com.azure.resourcemanager.batch.models.ResourceFile.ResourceFile()"
name: "ResourceFile()"
nameWithType: "ResourceFile.ResourceFile()"
summary: "Creates an instance of Resource<wbr>File class."
syntax: "public ResourceFile()"
desc: "Creates an instance of ResourceFile class."
methods:
- uid: "com.azure.resourcemanager.batch.models.ResourceFile.autoStorageContainerName()"
fullName: "com.azure.resourcemanager.batch.models.ResourceFile.autoStorageContainerName()"
name: "autoStorageContainerName()"
nameWithType: "ResourceFile.autoStorageContainerName()"
summary: "Get the auto<wbr>Storage<wbr>Container<wbr>Name property: The auto<wbr>Storage<wbr>Container<wbr>Name, storage<wbr>Container<wbr>Url and http<wbr>Url properties are mutually exclusive and one of them must be specified."
syntax: "public String autoStorageContainerName()"
desc: "Get the autoStorageContainerName property: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified."
returns:
description: "the autoStorageContainerName value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.batch.models.ResourceFile.blobPrefix()"
fullName: "com.azure.resourcemanager.batch.models.ResourceFile.blobPrefix()"
name: "blobPrefix()"
nameWithType: "ResourceFile.blobPrefix()"
summary: "Get the blob<wbr>Prefix property: The property is valid only when auto<wbr>Storage<wbr>Container<wbr>Name or storage<wbr>Container<wbr>Url is used."
syntax: "public String blobPrefix()"
desc: "Get the blobPrefix property: The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded."
returns:
description: "the blobPrefix value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.batch.models.ResourceFile.fileMode()"
fullName: "com.azure.resourcemanager.batch.models.ResourceFile.fileMode()"
name: "fileMode()"
nameWithType: "ResourceFile.fileMode()"
summary: "Get the file<wbr>Mode property: This property applies only to files being downloaded to Linux compute nodes."
syntax: "public String fileMode()"
desc: "Get the fileMode property: This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file."
returns:
description: "the fileMode value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.batch.models.ResourceFile.filePath()"
fullName: "com.azure.resourcemanager.batch.models.ResourceFile.filePath()"
name: "filePath()"
nameWithType: "ResourceFile.filePath()"
summary: "Get the file<wbr>Path property: If the http<wbr>Url property is specified, the file<wbr>Path is required and describes the path which the file will be downloaded to, including the filename."
syntax: "public String filePath()"
desc: "Get the filePath property: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..')."
returns:
description: "the filePath value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.batch.models.ResourceFile.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.resourcemanager.batch.models.ResourceFile.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "ResourceFile.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of Resource<wbr>File from the Json<wbr>Reader."
modifiers:
- "static"
parameters:
- description: "The JsonReader being read."
name: "jsonReader"
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static ResourceFile fromJson(JsonReader jsonReader)"
exceptions:
- description: "If an error occurs while reading the ResourceFile."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Reads an instance of ResourceFile from the JsonReader."
returns:
description: "An instance of ResourceFile if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
type: "<xref href=\"com.azure.resourcemanager.batch.models.ResourceFile?alt=com.azure.resourcemanager.batch.models.ResourceFile&text=ResourceFile\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.ResourceFile.httpUrl()"
fullName: "com.azure.resourcemanager.batch.models.ResourceFile.httpUrl()"
name: "httpUrl()"
nameWithType: "ResourceFile.httpUrl()"
summary: "Get the http<wbr>Url property: The auto<wbr>Storage<wbr>Container<wbr>Name, storage<wbr>Container<wbr>Url and http<wbr>Url properties are mutually exclusive and one of them must be specified."
syntax: "public String httpUrl()"
desc: "Get the httpUrl property: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access."
returns:
description: "the httpUrl value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.batch.models.ResourceFile.identityReference()"
fullName: "com.azure.resourcemanager.batch.models.ResourceFile.identityReference()"
name: "identityReference()"
nameWithType: "ResourceFile.identityReference()"
summary: "Get the identity<wbr>Reference property: The reference to a user assigned identity associated with the Batch pool which a compute node will use."
syntax: "public ComputeNodeIdentityReference identityReference()"
desc: "Get the identityReference property: The reference to a user assigned identity associated with the Batch pool which a compute node will use."
returns:
description: "the identityReference value."
type: "<xref href=\"com.azure.resourcemanager.batch.models.ComputeNodeIdentityReference?alt=com.azure.resourcemanager.batch.models.ComputeNodeIdentityReference&text=ComputeNodeIdentityReference\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.ResourceFile.storageContainerUrl()"
fullName: "com.azure.resourcemanager.batch.models.ResourceFile.storageContainerUrl()"
name: "storageContainerUrl()"
nameWithType: "ResourceFile.storageContainerUrl()"
summary: "Get the storage<wbr>Container<wbr>Url property: The auto<wbr>Storage<wbr>Container<wbr>Name, storage<wbr>Container<wbr>Url and http<wbr>Url properties are mutually exclusive and one of them must be specified."
syntax: "public String storageContainerUrl()"
desc: "Get the storageContainerUrl property: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the container to allow public access."
returns:
description: "the storageContainerUrl value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.batch.models.ResourceFile.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.resourcemanager.batch.models.ResourceFile.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "ResourceFile.toJson(JsonWriter jsonWriter)"
parameters:
- name: "jsonWriter"
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
exceptions:
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
returns:
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.ResourceFile.validate()"
fullName: "com.azure.resourcemanager.batch.models.ResourceFile.validate()"
name: "validate()"
nameWithType: "ResourceFile.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.batch.models.ResourceFile.withAutoStorageContainerName(java.lang.String)"
fullName: "com.azure.resourcemanager.batch.models.ResourceFile.withAutoStorageContainerName(String autoStorageContainerName)"
name: "withAutoStorageContainerName(String autoStorageContainerName)"
nameWithType: "ResourceFile.withAutoStorageContainerName(String autoStorageContainerName)"
summary: "Set the auto<wbr>Storage<wbr>Container<wbr>Name property: The auto<wbr>Storage<wbr>Container<wbr>Name, storage<wbr>Container<wbr>Url and http<wbr>Url properties are mutually exclusive and one of them must be specified."
parameters:
- description: "the autoStorageContainerName value to set."
name: "autoStorageContainerName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public ResourceFile withAutoStorageContainerName(String autoStorageContainerName)"
desc: "Set the autoStorageContainerName property: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified."
returns:
description: "the ResourceFile object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.models.ResourceFile?alt=com.azure.resourcemanager.batch.models.ResourceFile&text=ResourceFile\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.ResourceFile.withBlobPrefix(java.lang.String)"
fullName: "com.azure.resourcemanager.batch.models.ResourceFile.withBlobPrefix(String blobPrefix)"
name: "withBlobPrefix(String blobPrefix)"
nameWithType: "ResourceFile.withBlobPrefix(String blobPrefix)"
summary: "Set the blob<wbr>Prefix property: The property is valid only when auto<wbr>Storage<wbr>Container<wbr>Name or storage<wbr>Container<wbr>Url is used."
parameters:
- description: "the blobPrefix value to set."
name: "blobPrefix"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public ResourceFile withBlobPrefix(String blobPrefix)"
desc: "Set the blobPrefix property: The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded."
returns:
description: "the ResourceFile object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.models.ResourceFile?alt=com.azure.resourcemanager.batch.models.ResourceFile&text=ResourceFile\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.ResourceFile.withFileMode(java.lang.String)"
fullName: "com.azure.resourcemanager.batch.models.ResourceFile.withFileMode(String fileMode)"
name: "withFileMode(String fileMode)"
nameWithType: "ResourceFile.withFileMode(String fileMode)"
summary: "Set the file<wbr>Mode property: This property applies only to files being downloaded to Linux compute nodes."
parameters:
- description: "the fileMode value to set."
name: "fileMode"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public ResourceFile withFileMode(String fileMode)"
desc: "Set the fileMode property: This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file."
returns:
description: "the ResourceFile object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.models.ResourceFile?alt=com.azure.resourcemanager.batch.models.ResourceFile&text=ResourceFile\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.ResourceFile.withFilePath(java.lang.String)"
fullName: "com.azure.resourcemanager.batch.models.ResourceFile.withFilePath(String filePath)"
name: "withFilePath(String filePath)"
nameWithType: "ResourceFile.withFilePath(String filePath)"
summary: "Set the file<wbr>Path property: If the http<wbr>Url property is specified, the file<wbr>Path is required and describes the path which the file will be downloaded to, including the filename."
parameters:
- description: "the filePath value to set."
name: "filePath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public ResourceFile withFilePath(String filePath)"
desc: "Set the filePath property: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..')."
returns:
description: "the ResourceFile object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.models.ResourceFile?alt=com.azure.resourcemanager.batch.models.ResourceFile&text=ResourceFile\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.ResourceFile.withHttpUrl(java.lang.String)"
fullName: "com.azure.resourcemanager.batch.models.ResourceFile.withHttpUrl(String httpUrl)"
name: "withHttpUrl(String httpUrl)"
nameWithType: "ResourceFile.withHttpUrl(String httpUrl)"
summary: "Set the http<wbr>Url property: The auto<wbr>Storage<wbr>Container<wbr>Name, storage<wbr>Container<wbr>Url and http<wbr>Url properties are mutually exclusive and one of them must be specified."
parameters:
- description: "the httpUrl value to set."
name: "httpUrl"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public ResourceFile withHttpUrl(String httpUrl)"
desc: "Set the httpUrl property: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access."
returns:
description: "the ResourceFile object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.models.ResourceFile?alt=com.azure.resourcemanager.batch.models.ResourceFile&text=ResourceFile\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.ResourceFile.withIdentityReference(com.azure.resourcemanager.batch.models.ComputeNodeIdentityReference)"
fullName: "com.azure.resourcemanager.batch.models.ResourceFile.withIdentityReference(ComputeNodeIdentityReference identityReference)"
name: "withIdentityReference(ComputeNodeIdentityReference identityReference)"
nameWithType: "ResourceFile.withIdentityReference(ComputeNodeIdentityReference identityReference)"
summary: "Set the identity<wbr>Reference property: The reference to a user assigned identity associated with the Batch pool which a compute node will use."
parameters:
- description: "the identityReference value to set."
name: "identityReference"
type: "<xref href=\"com.azure.resourcemanager.batch.models.ComputeNodeIdentityReference?alt=com.azure.resourcemanager.batch.models.ComputeNodeIdentityReference&text=ComputeNodeIdentityReference\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ResourceFile withIdentityReference(ComputeNodeIdentityReference identityReference)"
desc: "Set the identityReference property: The reference to a user assigned identity associated with the Batch pool which a compute node will use."
returns:
description: "the ResourceFile object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.models.ResourceFile?alt=com.azure.resourcemanager.batch.models.ResourceFile&text=ResourceFile\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.ResourceFile.withStorageContainerUrl(java.lang.String)"
fullName: "com.azure.resourcemanager.batch.models.ResourceFile.withStorageContainerUrl(String storageContainerUrl)"
name: "withStorageContainerUrl(String storageContainerUrl)"
nameWithType: "ResourceFile.withStorageContainerUrl(String storageContainerUrl)"
summary: "Set the storage<wbr>Container<wbr>Url property: The auto<wbr>Storage<wbr>Container<wbr>Name, storage<wbr>Container<wbr>Url and http<wbr>Url properties are mutually exclusive and one of them must be specified."
parameters:
- description: "the storageContainerUrl value to set."
name: "storageContainerUrl"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public ResourceFile withStorageContainerUrl(String storageContainerUrl)"
desc: "Set the storageContainerUrl property: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the container to allow public access."
returns:
description: "the ResourceFile object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.models.ResourceFile?alt=com.azure.resourcemanager.batch.models.ResourceFile&text=ResourceFile\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "A single file or multiple files to be downloaded to a compute node."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.batch.models.ResourceFile?alt=com.azure.resourcemanager.batch.models.ResourceFile&text=ResourceFile\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.resourcemanager.batch.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-batch:2.0.0