AmazonS3ReadSettings Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Azure data lake store read settings.
[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.AmazonS3ReadSettings+AmazonS3ReadSettingsConverter))]
public class AmazonS3ReadSettings : Azure.Analytics.Synapse.Artifacts.Models.StoreReadSettings[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.AmazonS3ReadSettings+AmazonS3ReadSettingsConverter))>]
type AmazonS3ReadSettings = class
inherit StoreReadSettingsPublic Class AmazonS3ReadSettings
Inherits StoreReadSettings- Inheritance
- Attributes
-
System.Text.Json.Serialization.JsonConverterAttribute
Constructors
| AmazonS3ReadSettings() |
Initializes a new instance of AmazonS3ReadSettings. |
Properties
| DeleteFilesAfterCompletion |
Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean). |
| EnablePartitionDiscovery |
Indicates whether to enable partition discovery. |
| FileListPath |
Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string). |
| Item[String] |
Gets or sets the element with the specified key. (Inherited from StoreReadSettings) |
| Keys |
Gets an System.Collections.Generic.ICollection`1 containing the keys of the System.Collections.Generic.IDictionary`2. (Inherited from StoreReadSettings) |
| MaxConcurrentConnections |
The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). (Inherited from StoreReadSettings) |
| ModifiedDatetimeEnd |
The end of file's modified datetime. Type: string (or Expression with resultType string). |
| ModifiedDatetimeStart |
The start of file's modified datetime. Type: string (or Expression with resultType string). |
| PartitionRootPath |
Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string). |
| Prefix |
The prefix filter for the S3 object name. Type: string (or Expression with resultType string). |
| Recursive |
If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean). |
| Values |
Gets an System.Collections.Generic.ICollection`1 containing the values in the System.Collections.Generic.IDictionary`2. (Inherited from StoreReadSettings) |
| WildcardFileName |
AmazonS3 wildcardFileName. Type: string (or Expression with resultType string). |
| WildcardFolderPath |
AmazonS3 wildcardFolderPath. Type: string (or Expression with resultType string). |
Methods
| Add(String, Object) |
Adds an element with the provided key and value to the System.Collections.Generic.IDictionary`2. (Inherited from StoreReadSettings) |
| ContainsKey(String) |
Determines whether the System.Collections.Generic.IDictionary`2 contains an element with the specified key. (Inherited from StoreReadSettings) |
| GetEnumerator() |
Returns an enumerator that iterates through the collection. (Inherited from StoreReadSettings) |
| Remove(String) |
Removes the element with the specified key from the System.Collections.Generic.IDictionary`2. (Inherited from StoreReadSettings) |
| TryGetValue(String, Object) |
Gets the value associated with the specified key. (Inherited from StoreReadSettings) |
Explicit Interface Implementations
| ICollection<KeyValuePair<String,Object>>.Add(KeyValuePair<String,Object>) |
Adds an item to the System.Collections.Generic.ICollection`1. (Inherited from StoreReadSettings) |
| ICollection<KeyValuePair<String,Object>>.Clear() |
Removes all items from the System.Collections.Generic.ICollection`1. (Inherited from StoreReadSettings) |
| ICollection<KeyValuePair<String,Object>>.Contains(KeyValuePair<String,Object>) |
Determines whether the System.Collections.Generic.ICollection`1 contains a specific value. (Inherited from StoreReadSettings) |
| ICollection<KeyValuePair<String,Object>>.CopyTo(KeyValuePair<String,Object>[], Int32) |
Copies the elements of the System.Collections.Generic.ICollection`1 to an System.Array, starting at a particular System.Array index. (Inherited from StoreReadSettings) |
| ICollection<KeyValuePair<String,Object>>.Count |
Gets the number of elements contained in the System.Collections.Generic.ICollection`1. (Inherited from StoreReadSettings) |
| ICollection<KeyValuePair<String,Object>>.IsReadOnly |
Gets a value indicating whether the System.Collections.Generic.ICollection`1 is read-only. (Inherited from StoreReadSettings) |
| ICollection<KeyValuePair<String,Object>>.Remove(KeyValuePair<String,Object>) |
Removes the first occurrence of a specific object from the System.Collections.Generic.ICollection`1. (Inherited from StoreReadSettings) |
| IEnumerable.GetEnumerator() |
Returns an enumerator that iterates through a collection. (Inherited from StoreReadSettings) |
Extension Methods
| GetValueOrAdd<TKey,TValue>(IDictionary<TKey,TValue>, TKey, Func<TKey,TValue>) |
Gets or adds the value associated with specified key. |
| GetValueOrDefault<TKey,TValue>(IDictionary<TKey,TValue>, TKey, TValue) |
Gets the value associated with specified key. |