Skip to main content

A set of string constants for the parameter UploadFilesRequest.options. More…

Static Public Attributes

const string FILE_ENCODING = “file_encoding”
 Encoding that has been applied to the uploaded file data.
 
const string BASE64 = “base64”
 Specifies that the file data being uploaded has been base64 encoded.
 
const string NONE = “none”
 Default, indicates this is not a multipart upload.
 
const string MULTIPART_OPERATION = “multipart_operation”
 Multipart upload operation to perform.
 
const string INIT = “init”
 Initialize a multipart file upload.
 
const string UPLOAD_PART = “upload_part”
 Uploads a part of the specified multipart file upload.
 
const string COMPLETE = “complete”
 Complete the specified multipart file upload.
 
const string CANCEL = “cancel”
 Cancel the specified multipart file upload.
 
const string MULTIPART_UPLOAD_UUID = “multipart_upload_uuid”
 UUID to uniquely identify a multipart upload.
 
const string MULTIPART_UPLOAD_PART_NUMBER = “multipart_upload_part_number”
 Incremental part number for each part in a multipart upload.
 
const string DELETE_IF_EXISTS = “delete_if_exists”
 If TRUE, any existing files specified in UploadFilesRequest.file_names will be deleted prior to start of upload.
 
const string TRUE = “true”
 A boolean constant for the UploadFilesRequest.Options options.
 
const string FALSE = “false”
 A boolean constant for the UploadFilesRequest.Options options.
 

Detailed Description

A set of string constants for the parameter UploadFilesRequest.options.

Optional parameters.

Definition at line 75 of file UploadFiles.cs.

Member Data Documentation

◆ BASE64

const string kinetica.UploadFilesRequest.Options.BASE64 = “base64”
static

Specifies that the file data being uploaded has been base64 encoded.

Definition at line 105 of file UploadFiles.cs.

◆ CANCEL

const string kinetica.UploadFilesRequest.Options.CANCEL = “cancel”
static

Cancel the specified multipart file upload.

Definition at line 163 of file UploadFiles.cs.

◆ COMPLETE

const string kinetica.UploadFilesRequest.Options.COMPLETE = “complete”
static

Complete the specified multipart file upload.

Definition at line 160 of file UploadFiles.cs.

◆ DELETE_IF_EXISTS

const string kinetica.UploadFilesRequest.Options.DELETE_IF_EXISTS = “delete_if_exists”
static

If TRUE, any existing files specified in UploadFilesRequest.file_names will be deleted prior to start of upload.

Otherwise the file is replaced once the upload completes. Rollback of the original file is no longer possible if the upload is cancelled, aborted or fails if the file was deleted beforehand. Supported values:

The default value is FALSE.

Definition at line 196 of file UploadFiles.cs.

◆ FALSE

const string kinetica.UploadFilesRequest.Options.FALSE = “false”
static

A boolean constant for the UploadFilesRequest.Options options.

Definition at line 204 of file UploadFiles.cs.

◆ FILE_ENCODING

const string kinetica.UploadFilesRequest.Options.FILE_ENCODING = “file_encoding”
static

Encoding that has been applied to the uploaded file data.

When using JSON serialization it is recommended to utilize BASE64. The caller is responsible for encoding the data provided in this payload. Supported values:

  • BASE64: Specifies that the file data being uploaded has been base64 encoded.
  • NONE: The uploaded file data has not been encoded.

The default value is NONE.

Definition at line 101 of file UploadFiles.cs.

◆ INIT

const string kinetica.UploadFilesRequest.Options.INIT = “init”
static

Initialize a multipart file upload.

Definition at line 153 of file UploadFiles.cs.

◆ MULTIPART_OPERATION

const string kinetica.UploadFilesRequest.Options.MULTIPART_OPERATION = “multipart_operation”
static

Multipart upload operation to perform.

Supported values:

  • NONE: Default, indicates this is not a multipart upload.
  • INIT: Initialize a multipart file upload.
  • UPLOAD_PART: Uploads a part of the specified multipart file upload.
  • COMPLETE: Complete the specified multipart file upload.
  • CANCEL: Cancel the specified multipart file upload.

The default value is NONE.

Definition at line 150 of file UploadFiles.cs.

◆ MULTIPART_UPLOAD_PART_NUMBER

const string kinetica.UploadFilesRequest.Options.MULTIPART_UPLOAD_PART_NUMBER = “multipart_upload_part_number”
static

Incremental part number for each part in a multipart upload.

Part numbers start at 1, increment by 1, and must be uploaded sequentially

Definition at line 172 of file UploadFiles.cs.

◆ MULTIPART_UPLOAD_UUID

const string kinetica.UploadFilesRequest.Options.MULTIPART_UPLOAD_UUID = “multipart_upload_uuid”
static

UUID to uniquely identify a multipart upload.

Definition at line 166 of file UploadFiles.cs.

◆ NONE

const string kinetica.UploadFilesRequest.Options.NONE = “none”
static

Default, indicates this is not a multipart upload.

Definition at line 109 of file UploadFiles.cs.

◆ TRUE

const string kinetica.UploadFilesRequest.Options.TRUE = “true”
static

A boolean constant for the UploadFilesRequest.Options options.

Definition at line 200 of file UploadFiles.cs.

◆ UPLOAD_PART

const string kinetica.UploadFilesRequest.Options.UPLOAD_PART = “upload_part”
static

Uploads a part of the specified multipart file upload.

Definition at line 157 of file UploadFiles.cs.


The documentation for this struct was generated from the following files: