The Client type exposes the following members.
Constructors
Name | Description | |
---|---|---|
Client |
Initialize Client object with ClientOptions settings
|
Methods
Name | Description | |
---|---|---|
Append(CosmosUri, array<Byte>[]()[][], Boolean) |
This function appends the given data in byte array to the specified stream.
| |
Append(CosmosUri, array<Byte>[]()[][], Int64, Boolean) |
This function appends the given data in byte array to the specified stream.
The append starts at the given streamFixedOffset in the destination stream. If the stream already contains data in the
streamFixedOffset position and it is different from the data that is being appended, then this operation will fail.
| |
AppendFile(CosmosUri, String, Boolean) |
This function appends the given file to the specified stream. The file in its entirety will be appended to the stream. The file must use
new line characters '\n', '\r', "\n\r", and/or "\r\n" (the file can contain more than one of these) with lines being less than or equal
to 4MB (including new line characters).
| |
AppendFile(CosmosUri, String, Int64, Boolean) |
This function appends the given file to the specified stream. The file in its entirety will be appended to the stream. The file must use
new line characters '\n', '\r', "\n\r", and/or "\r\n" (the file can contain more than one of these) with lines being less than or equal
to 4MB (including new line characters). The append starts at the given streamFixedOffset in the destination stream.
If the stream already contains data in the streamFixedOffset position and it is different from the data that is being
appended, then this operation will fail.
| |
AppendFile(CosmosUri, String, Int64, Int64, Boolean) |
This function appends the given file to the specified stream. The data will be read from the local file starting at offset and the number of
bytes appended will be equal to length. The file must use new line characters '\n', '\r', "\n\r", and/or "\r\n" (the file can contain more
than one of these) with lines being less than or equal to 4MB (including new line characters).
| |
AppendFile(CosmosUri, String, Int64, Int64, Int64, Boolean) |
This function appends the given file to the specified stream. The data will be read from the local file starting
at offset and the number of bytes appended will be equal to length. The file must use new line characters '\n', '\r', "\n\r", and/or "\r\n"
(the file can contain more than one of these) with lines being less than or equal to 4MB (including new line characters).
The append starts at the given streamFixedOffset in the destination stream. If the stream already contains data in the
streamFixedOffset position and it is different from the data that is being appended, then this operation will fail.
| |
AppendFile(CosmosUri, String, Int64, Int64, Int64, Boolean, Boolean) |
This function appends the given file to the specified stream. The data will be read from the local file starting
at offset and the number of bytes appended will be equal to length. The file must use new line characters '\n', '\r', "\n\r", and/or "\r\n"
(the file can contain more than one of these) with lines being less than or equal to 4MB (including new line characters).
The append starts at the given streamFixedOffset in the destination stream. If the stream already contains data in the
streamFixedOffset position and it is different from the data that is being appended, then this operation will fail.
| |
CancelJob |
This function cancels a job with a given job ID.
| |
Concatenate |
This function initiates concatenation of the two given streams. If the streams are on different volumes,
this operation may take some time to complete.
| |
Create(CosmosUri) |
This function creates a stream on the virtual cluster.
| |
Create(CosmosUri, TimeSpan) |
This function creates a stream on the virtual cluster. It will also assign the expiration time for the stream.
| |
Delete |
This function deletes the given stream. Deletion puts the stream into a "recycled" state. For immediate, non-recoverable deletions
see the Purge(CosmosUri) method.
| |
DirectoryExists |
This function checks if a given directory exists or not.
| |
Download(CosmosUri, String, Boolean, Boolean) |
This function downloads a stream on the virtual cluster to the local machine. The download will copy the entire
stream, from the beginning to end.
| |
Download(CosmosUri, String, Boolean, DownloadMode) |
This function downloads a stream on the virtual cluster to the local machine. The download will copy the entire
stream, from the beginning to end.
| |
Download(CosmosUri, String, Int64, Boolean, Boolean) |
This function downloads a stream on the virtual cluster to the local machine. The download will start at the specified
offset and copy until the end of the stream.
| |
Download(CosmosUri, String, Int64, Boolean, DownloadMode) |
This function downloads a stream on the virtual cluster to the local machine. The download will start at the specified
offset and copy until the end of the stream.
| |
Download(CosmosUri, String, Int64, Int64, Boolean, Boolean) |
This function downloads a stream on the virtual cluster to the local machine. The download will start at the specified
offset and copy "length" number of bytes.
| |
Download(CosmosUri, String, Int64, Int64, Boolean, DownloadMode) |
This function downloads a stream on the virtual cluster to the local machine. The download will start at the specified
offset and copy "length" number of bytes.
| |
FindJobs |
Based on specified finding criteria, return qualified jobs.
| |
GetDataUploadProgress |
Gets Cosmos Data Loader (CDL) V2 data upload progress metrics for a given day or hour.
| |
GetDirectoryInfo |
This function gets the StreamInfo for a given directory.
| |
GetJobInfo |
Gets the information about the job with a given job id.
| |
GetJobStatistics |
This function returns the JobStatistics object that contains statistical information about each job stage. The
object includes information about the number of vertices failed, succeeded, data read, etc.
| |
GetStreamInfo |
Gets the StreamInfo for a stream.
| |
GetStreamSetInfo(CosmosUri, Boolean) |
This function gets the StreamInfo of each stream in the given streamset.
| |
GetStreamSetInfo(CosmosUri, Boolean, Boolean) |
This function gets the StreamInfo of each stream in the given streamset.
| |
GetStreamSetInfo(CosmosUri, Boolean, String, String) |
This function gets the StreamInfo of each stream in the given streamset.
| |
GetStreamSetInfo(CosmosUri, Boolean, String, String, Boolean) |
This function gets the StreamInfo of each stream in the given streamset.
| |
GetVcList |
Get a list of VCs in this cluster
| |
LogAppend(CosmosUri, array<Byte>[]()[][], Boolean, IDictionary<(Of <<'(String, String>)>>)) |
This appends the given data in the byte array to the log stream on the virtual cluster whose "key" and "value"
match the key and value. hmKeyValue contains key-value pairs and the append operation will be performed for each
key-value pair.
| |
LogAppend(CosmosUri, array<Byte>[]()[][], Boolean, String, String) |
This appends the given data in the byte array to the log stream on the virtual cluster whose "key" and "value"
match the key and value.
| |
LogAppend(CosmosUri, array<Byte>[]()[][], Int32, Int32, Boolean, IDictionary<(Of <<'(String, String>)>>)) |
This appends the given data in the byte array to the log stream on the virtual cluster whose "key" and "value"
match the key and value. hmKeyValue contains key-value pairs and the append operation will be performed for each
key-value pair.
| |
LogAppend(CosmosUri, array<Byte>[]()[][], Int32, Int32, CompressionLevel, IDictionary<(Of <<'(String, String>)>>)) |
This appends the given data in the byte array to the log stream on the virtual cluster whose "key" and "value"
match the key and value. hmKeyValue contains key-value pairs and the append operation will be performed for each
key-value pair.
| |
LogAppend(CosmosUri, array<Byte>[]()[][], Int32, Int32, Boolean, String, String) |
This appends the given data in the byte array to the log stream on the virtual cluster whose "key" and "value"
match the key and value.
| |
LogAppendFile |
This appends the data in the given file to the log stream on the virtual cluster whose "key" and "value"
match the key and value. hmKeyValue contains key-value pairs and the append operation will
be performed for each key-value pair.
| |
Purge |
This function permanently deletes the given stream. This operation **CANNOT** be undone! For recoverable deletions, see the Delete(String) method.
Purge is restricted to VC admins only.
| |
ReadStream(CosmosUri, Boolean) |
This function reads a stream from the virtual cluster and returns a stream object. The stream will be read from
the beginning and until the end of the stream is reached.
| |
ReadStream(CosmosUri, Int64, Boolean) |
This function reads a stream from the virtual cluster and returns a stream object. The stream will be read from
the specified offset until the end of the stream is reached.
| |
ReadStream(CosmosUri, Int64, Int64, Boolean) |
This function reads a stream from the virtual cluster and returns a stream object. The stream will be read from
the specified offset for the given length.
| |
Rename(CosmosUri, CosmosUri) |
This function renames the given stream.
| |
Rename(CosmosUri, CosmosUri, Boolean) |
This function renames the given stream.
| |
SetStreamProperty(CosmosUri, TimeSpan) |
This function sets the expiration time for a given stream. Once the stream expires, it will be deleted.
| |
SetStreamProperty(CosmosUri, StreamFlags) |
Set or clear stream level flags
| |
StreamExists(CosmosUri) |
This function checks if a given stream exists or not. Using this function on stream sets results in undefined behavior; please
use GetStreamSetInfo(CosmosUri, Boolean) or one of its overloads instead.
| |
StreamExists(CosmosUri, Boolean) |
This function checks if a given stream exists or not. Using this function on stream sets results in undefined behavior; please
use GetStreamSetInfo(CosmosUri, Boolean) or one of its overloads instead.
| |
SubmitJob |
Submitting a job. This function is not intended to be called by customers, but by Scope.exe internally only.
SubmitJobParameters.JobType should be set to differentiate among Scope/commandline/algebra jobs.
| |
UpdateJob |
Update job properties, such as priority and VC allocation, of a queued or running job.
| |
Upload(String, CosmosUri, Boolean) |
This function uploads the given file to the vc. The local file in its entirety will be uploaded. The destination stream will be
created during this operation and cannot exist prior to upload.
| |
Upload(array<Byte>[]()[][], CosmosUri, Boolean, TimeSpan) |
This function uploads the given byte array data to the VC. The destination stream will be
created during this operation and cannot exist prior to upload.
| |
Upload(String, CosmosUri, Boolean, TimeSpan) |
This function uploads the given file to the vc. The local file in its entirety will be uploaded. The destination stream will be
created during this operation and cannot exist prior to upload.
| |
Upload(String, CosmosUri, Boolean, TimeSpan, Boolean) |
This function uploads the given file to the vc. The local file in its entirety will be uploaded. The destination stream will be
created during this operation and cannot exist prior to upload.
| |
Upload(String, CosmosUri, Int64, Int64, Boolean) |
This function uploads the given file to the vc. The data will be read from the local file starting
at offset and the number of bytes appended will be equal to length. The destination stream will be
created during this operation and cannot exist prior to upload.
| |
Upload(String, CosmosUri, Int64, Int64, Boolean, TimeSpan, Boolean) |
This function uploads the given file to the vc. The data will be read from the local file starting
at offset and the number of bytes appended will be equal to length. The destination stream will be
created during this operation and cannot exist prior to upload.
| |
UploadWithBlockBoundaries |
This function uploads the given local file to cosmos cluster, while preserving the specified block boundaries. The destination stream will be
created during this operation and cannot exist prior to upload.
| |
YieldJob |
Yield job.
|