Class: Azure::Batch::Mgmt::V2018_12_01::Models::ResourceFile

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-12-01/generated/azure_mgmt_batch/models/resource_file.rb

Overview

A single file or multiple files to be downloaded to a compute node.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#auto_storage_container_name ⇒ String

account. The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified.

Returns:

  • (String) —

    The storage container name in the auto storage



19
20
21
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/resource_file.rb', line 19

def auto_storage_container_name
  @auto_storage_container_name
end

#blob_prefix ⇒ String

Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded. 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:

  • (String) —

    The blob prefix to use when downloading blobs from an



49
50
51
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/resource_file.rb', line 49

def blob_prefix
  @blob_prefix
end

#file_mode ⇒ String

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:

  • (String) —

    The file permission mode attribute in octal format.



69
70
71
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/resource_file.rb', line 69

def file_mode
  @file_mode
end

#file_path ⇒ String

the file, relative to the task’s working directory. 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:

  • (String) —

    The location on the compute node to which to download



62
63
64
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/resource_file.rb', line 62

def file_path
  @file_path
end

#http_url ⇒ String

autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL is Azure Blob Storage, it must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access.

Returns:

  • (String) —

    The URL of the file to download. The



41
42
43
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/resource_file.rb', line 41

def http_url
  @http_url
end

#storage_container_url ⇒ String

Storage. The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the blob, or set the ACL for the blob or its container to allow public access.

Returns:

  • (String) —

    The URL of the blob container within Azure Blob



30
31
32
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/resource_file.rb', line 30

def storage_container_url
  @storage_container_url
end

Class Method Details

.mapper ⇒ Object

Mapper for ResourceFile class as Ruby Hash. This will be used for serialization/deserialization.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/resource_file.rb', line 76

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'ResourceFile',
    type: {
      name: 'Composite',
      class_name: 'ResourceFile',
      model_properties: {
        auto_storage_container_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'autoStorageContainerName',
          type: {
            name: 'String'
          }
        },
        storage_container_url: {
          client_side_validation: true,
          required: false,
          serialized_name: 'storageContainerUrl',
          type: {
            name: 'String'
          }
        },
        http_url: {
          client_side_validation: true,
          required: false,
          serialized_name: 'httpUrl',
          type: {
            name: 'String'
          }
        },
        blob_prefix: {
          client_side_validation: true,
          required: false,
          serialized_name: 'blobPrefix',
          type: {
            name: 'String'
          }
        },
        file_path: {
          client_side_validation: true,
          required: false,
          serialized_name: 'filePath',
          type: {
            name: 'String'
          }
        },
        file_mode: {
          client_side_validation: true,
          required: false,
          serialized_name: 'fileMode',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end