The Client type exposes the following members.

Methods

  NameDescription
Public methodAppend(CosmosUri, array<Byte>[]()[][], Boolean)
This function appends the given data in byte array to the specified stream.
Public methodAppend(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.
Public methodAppendFile(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).
Public methodAppendFile(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.
Public methodAppendFile(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).
Public methodAppendFile(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.
Public methodAppendFile(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.
Public methodCancelJob
This function cancels a job with a given job ID.
Public methodConcatenate
This function initiates concatenation of the two given streams. If the streams are on different volumes, this operation may take some time to complete.
Public methodCreate(CosmosUri)
This function creates a stream on the virtual cluster.
Public methodCreate(CosmosUri, TimeSpan)
This function creates a stream on the virtual cluster. It will also assign the expiration time for the stream.
Public methodDelete
This function deletes the given stream. Deletion puts the stream into a "recycled" state. For immediate, non-recoverable deletions see the Purge(CosmosUri) method.
Public methodDirectoryExists
This function checks if a given directory exists or not.
Public methodDownload(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.
Public methodDownload(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.
Public methodDownload(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.
Public methodDownload(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.
Public methodDownload(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.
Public methodDownload(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.
Public methodFindJobs
Based on specified finding criteria, return qualified jobs.
Public methodGetDataUploadProgress
Gets Cosmos Data Loader (CDL) V2 data upload progress metrics for a given day or hour.
Public methodGetDirectoryInfo
This function gets the StreamInfo for a given directory.
Public methodGetJobInfo
Gets the information about the job with a given job id.
Public methodGetJobStatistics
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.
Public methodGetStreamInfo
Gets the StreamInfo for a stream.
Public methodGetStreamSetInfo(CosmosUri, Boolean)
This function gets the StreamInfo of each stream in the given streamset.
Public methodGetStreamSetInfo(CosmosUri, Boolean, Boolean)
This function gets the StreamInfo of each stream in the given streamset.
Public methodGetStreamSetInfo(CosmosUri, Boolean, String, String)
This function gets the StreamInfo of each stream in the given streamset.
Public methodGetStreamSetInfo(CosmosUri, Boolean, String, String, Boolean)
This function gets the StreamInfo of each stream in the given streamset.
Public methodGetVcList
Get a list of VCs in this cluster
Public methodLogAppend(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.
Public methodLogAppend(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.
Public methodLogAppend(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.
Public methodLogAppend(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.
Public methodLogAppend(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.
Public methodLogAppendFile
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.
Public methodPurge
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.
Public methodReadStream(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.
Public methodReadStream(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.
Public methodReadStream(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.
Public methodRename(CosmosUri, CosmosUri)
This function renames the given stream.
Public methodRename(CosmosUri, CosmosUri, Boolean)
This function renames the given stream.
Public methodSetStreamProperty(CosmosUri, TimeSpan)
This function sets the expiration time for a given stream. Once the stream expires, it will be deleted.
Public methodSetStreamProperty(CosmosUri, StreamFlags)
Set or clear stream level flags
Public methodStreamExists(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.
Public methodStreamExists(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.
Public methodSubmitJob
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.
Public methodUpdateJob
Update job properties, such as priority and VC allocation, of a queued or running job.
Public methodUpload(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.
Public methodUpload(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.
Public methodUpload(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.
Public methodUpload(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.
Public methodUpload(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.
Public methodUpload(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.
Public methodUploadWithBlockBoundaries
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.
Public methodYieldJob
Yield job.

See Also