< Summary

Class:Microsoft.Azure.Batch.Protocol.Models.ResourceFile
Assembly:Microsoft.Azure.Batch
File(s):C:\Git\azure-sdk-for-net\sdk\batch\Microsoft.Azure.Batch\src\GeneratedProtocol\Models\ResourceFile.cs
Covered lines:16
Uncovered lines:0
Coverable lines:16
Total lines:154
Line coverage:100% (16 of 16)
Covered branches:0
Total branches:0

Metrics

MethodCyclomatic complexity Line coverage Branch coverage
.ctor()-100%100%
.ctor(...)-100%100%
get_AutoStorageContainerName()-100%100%
get_StorageContainerUrl()-100%100%
get_HttpUrl()-100%100%
get_BlobPrefix()-100%100%
get_FilePath()-100%100%
get_FileMode()-100%100%

File(s)

C:\Git\azure-sdk-for-net\sdk\batch\Microsoft.Azure.Batch\src\GeneratedProtocol\Models\ResourceFile.cs

#LineLine coverage
 1// <auto-generated>
 2// Copyright (c) Microsoft Corporation. All rights reserved.
 3// Licensed under the MIT License. See License.txt in the project root for
 4// license information.
 5//
 6// Code generated by Microsoft (R) AutoRest Code Generator.
 7// Changes may cause incorrect behavior and will be lost if the code is
 8// regenerated.
 9// </auto-generated>
 10
 11namespace Microsoft.Azure.Batch.Protocol.Models
 12{
 13    using Newtonsoft.Json;
 14    using System.Linq;
 15
 16    /// <summary>
 17    /// A single file or multiple files to be downloaded to a Compute Node.
 18    /// </summary>
 19    public partial class ResourceFile
 20    {
 21        /// <summary>
 22        /// Initializes a new instance of the ResourceFile class.
 23        /// </summary>
 1349324        public ResourceFile()
 25        {
 26            CustomInit();
 1349327        }
 28
 29        /// <summary>
 30        /// Initializes a new instance of the ResourceFile class.
 31        /// </summary>
 32        /// <param name="autoStorageContainerName">The storage container name
 33        /// in the auto storage Account.</param>
 34        /// <param name="storageContainerUrl">The URL of the blob container
 35        /// within Azure Blob Storage.</param>
 36        /// <param name="httpUrl">The URL of the file to download.</param>
 37        /// <param name="blobPrefix">The blob prefix to use when downloading
 38        /// blobs from an Azure Storage container. Only the blobs whose names
 39        /// begin with the specified prefix will be downloaded.</param>
 40        /// <param name="filePath">The location on the Compute Node to which to
 41        /// download the file(s), relative to the Task's working
 42        /// directory.</param>
 43        /// <param name="fileMode">The file permission mode attribute in octal
 44        /// format.</param>
 145        public ResourceFile(string autoStorageContainerName = default(string), string storageContainerUrl = default(stri
 46        {
 147            AutoStorageContainerName = autoStorageContainerName;
 148            StorageContainerUrl = storageContainerUrl;
 149            HttpUrl = httpUrl;
 150            BlobPrefix = blobPrefix;
 151            FilePath = filePath;
 152            FileMode = fileMode;
 53            CustomInit();
 154        }
 55
 56        /// <summary>
 57        /// An initialization method that performs custom operations like setting defaults
 58        /// </summary>
 59        partial void CustomInit();
 60
 61        /// <summary>
 62        /// Gets or sets the storage container name in the auto storage
 63        /// Account.
 64        /// </summary>
 65        /// <remarks>
 66        /// The autoStorageContainerName, storageContainerUrl and httpUrl
 67        /// properties are mutually exclusive and one of them must be
 68        /// specified.
 69        /// </remarks>
 70        [JsonProperty(PropertyName = "autoStorageContainerName")]
 3243171        public string AutoStorageContainerName { get; set; }
 72
 73        /// <summary>
 74        /// Gets or sets the URL of the blob container within Azure Blob
 75        /// Storage.
 76        /// </summary>
 77        /// <remarks>
 78        /// The autoStorageContainerName, storageContainerUrl and httpUrl
 79        /// properties are mutually exclusive and one of them must be
 80        /// specified. This URL must be readable and listable using anonymous
 81        /// access; that is, the Batch service does not present any credentials
 82        /// when downloading blobs from the container. There are two ways to
 83        /// get such a URL for a container in Azure storage: include a Shared
 84        /// Access Signature (SAS) granting read and list permissions on the
 85        /// container, or set the ACL for the container to allow public access.
 86        /// </remarks>
 87        [JsonProperty(PropertyName = "storageContainerUrl")]
 3238588        public string StorageContainerUrl { get; set; }
 89
 90        /// <summary>
 91        /// Gets or sets the URL of the file to download.
 92        /// </summary>
 93        /// <remarks>
 94        /// The autoStorageContainerName, storageContainerUrl and httpUrl
 95        /// properties are mutually exclusive and one of them must be
 96        /// specified. If the URL points to Azure Blob Storage, it must be
 97        /// readable using anonymous access; that is, the Batch service does
 98        /// not present any credentials when downloading the blob. There are
 99        /// two ways to get such a URL for a blob in Azure storage: include a
 100        /// Shared Access Signature (SAS) granting read permissions on the
 101        /// blob, or set the ACL for the blob or its container to allow public
 102        /// access.
 103        /// </remarks>
 104        [JsonProperty(PropertyName = "httpUrl")]
 32504105        public string HttpUrl { get; set; }
 106
 107        /// <summary>
 108        /// Gets or sets the blob prefix to use when downloading blobs from an
 109        /// Azure Storage container. Only the blobs whose names begin with the
 110        /// specified prefix will be downloaded.
 111        /// </summary>
 112        /// <remarks>
 113        /// The property is valid only when autoStorageContainerName or
 114        /// storageContainerUrl is used. This prefix can be a partial filename
 115        /// or a subdirectory. If a prefix is not specified, all the files in
 116        /// the container will be downloaded.
 117        /// </remarks>
 118        [JsonProperty(PropertyName = "blobPrefix")]
 32512119        public string BlobPrefix { get; set; }
 120
 121        /// <summary>
 122        /// Gets or sets the location on the Compute Node to which to download
 123        /// the file(s), relative to the Task's working directory.
 124        /// </summary>
 125        /// <remarks>
 126        /// If the httpUrl property is specified, the filePath is required and
 127        /// describes the path which the file will be downloaded to, including
 128        /// the filename. Otherwise, if the autoStorageContainerName or
 129        /// storageContainerUrl property is specified, filePath is optional and
 130        /// is the directory to download the files to. In the case where
 131        /// filePath is used as a directory, any directory structure already
 132        /// associated with the input data will be retained in full and
 133        /// appended to the specified filePath directory. The specified
 134        /// relative path cannot break out of the Task's working directory (for
 135        /// example by using '..').
 136        /// </remarks>
 137        [JsonProperty(PropertyName = "filePath")]
 32498138        public string FilePath { get; set; }
 139
 140        /// <summary>
 141        /// Gets or sets the file permission mode attribute in octal format.
 142        /// </summary>
 143        /// <remarks>
 144        /// This property applies only to files being downloaded to Linux
 145        /// Compute Nodes. It will be ignored if it is specified for a
 146        /// resourceFile which will be downloaded to a Windows Compute Node. If
 147        /// this property is not specified for a Linux Compute Node, then a
 148        /// default value of 0770 is applied to the file.
 149        /// </remarks>
 150        [JsonProperty(PropertyName = "fileMode")]
 32563151        public string FileMode { get; set; }
 152
 153    }
 154}
Generated by: ReportGenerator 4.6.4.0
8/12/2020 - 3:47:12 PM
GitHub | www.palmmedia.de

Methods/Properties

.ctor()
.ctor(...)
get_AutoStorageContainerName()
get_StorageContainerUrl()
get_HttpUrl()
get_BlobPrefix()
get_FilePath()
get_FileMode()