Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
Public Attributes | List of all members
kinetica.UploadFilesRequest.Options Struct Reference

Optional parameters. More...

Public Attributes

const string FILE_ENCODING = "file_encoding"
 Encoding that has been applied to the uploaded file data. More...
 
const string BASE64 = "base64"
 Specifies that the file data being uploaded has been base64 encoded. More...
 
const string NONE = "none"
 Default, indicates this is not a multipart upload More...
 
const string MULTIPART_OPERATION = "multipart_operation"
 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. More...

 
const string INIT = "init"
 Initialize a multipart file upload More...
 
const string UPLOAD_PART = "upload_part"
 Uploads a part of the specified multipart file upload More...
 
const string COMPLETE = "complete"
 Complete the specified multipart file upload More...
 
const string CANCEL = "cancel"
 Cancel the specified multipart file upload More...
 
const string MULTIPART_UPLOAD_UUID = "multipart_upload_uuid"
 UUID to uniquely identify a multipart upload More...
 
const string MULTIPART_UPLOAD_PART_NUMBER = "multipart_upload_part_number"
 Incremental part number for each part in a multipart upload. More...
 
const string DELETE_IF_EXISTS = "delete_if_exists"
 If true, any existing files specified in file_names will be deleted prior to start of upload. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 

Detailed Description

Optional parameters.

  • FILE_ENCODING: 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.
  • MULTIPART_OPERATION: 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.
  • MULTIPART_UPLOAD_UUID: UUID to uniquely identify a multipart upload
  • MULTIPART_UPLOAD_PART_NUMBER: Incremental part number for each part in a multipart upload. Part numbers start at 1, increment by 1, and must be uploaded sequentially
  • DELETE_IF_EXISTS: If true, any existing files specified in 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.

The default value is an empty Dictionary. A set of string constants for the parameter options.

Definition at line 202 of file UploadFiles.cs.

Member Data Documentation

const string kinetica.UploadFilesRequest.Options.BASE64 = "base64"

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

Definition at line 231 of file UploadFiles.cs.

const string kinetica.UploadFilesRequest.Options.CANCEL = "cancel"

Cancel the specified multipart file upload

Definition at line 286 of file UploadFiles.cs.

const string kinetica.UploadFilesRequest.Options.COMPLETE = "complete"

Complete the specified multipart file upload

Definition at line 283 of file UploadFiles.cs.

const string kinetica.UploadFilesRequest.Options.DELETE_IF_EXISTS = "delete_if_exists"

If true, any existing files specified in 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 317 of file UploadFiles.cs.

const string kinetica.UploadFilesRequest.Options.FALSE = "false"

Definition at line 319 of file UploadFiles.cs.

const string kinetica.UploadFilesRequest.Options.FILE_ENCODING = "file_encoding"

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 227 of file UploadFiles.cs.

const string kinetica.UploadFilesRequest.Options.INIT = "init"

Initialize a multipart file upload

Definition at line 276 of file UploadFiles.cs.

const string kinetica.UploadFilesRequest.Options.MULTIPART_OPERATION = "multipart_operation"

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 273 of file UploadFiles.cs.

const string kinetica.UploadFilesRequest.Options.MULTIPART_UPLOAD_PART_NUMBER = "multipart_upload_part_number"

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 295 of file UploadFiles.cs.

const string kinetica.UploadFilesRequest.Options.MULTIPART_UPLOAD_UUID = "multipart_upload_uuid"

UUID to uniquely identify a multipart upload

Definition at line 289 of file UploadFiles.cs.

const string kinetica.UploadFilesRequest.Options.NONE = "none"

Default, indicates this is not a multipart upload

Definition at line 235 of file UploadFiles.cs.

const string kinetica.UploadFilesRequest.Options.TRUE = "true"

Definition at line 318 of file UploadFiles.cs.

const string kinetica.UploadFilesRequest.Options.UPLOAD_PART = "upload_part"

Uploads a part of the specified multipart file upload

Definition at line 280 of file UploadFiles.cs.

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