Struct cloudfiles::AmazonGlacier

Properties   Methods   Events   Config Settings   Errors  

The AmazonGlacier struct provides a quick way to interface with Amazon's Glacier service.

Syntax

cloudfiles::AmazonGlacier

Remarks

The AmazonGlacier struct allows you to simply access Amazon's Glacier service. Glacier allows you to create vaults and store archives.

Before using the struct you must first have an AWS account and sign up for the Glacier service. To use the struct first set access_key and secret_key.

To create a vault call create_vault. Once the vault is created you are ready to upload archives to store in the vault. Set local_file to the file you want to upload and call upload_archive.

To retrieve an archive you must create a job. Jobs are long running operations and Amazon will notify you when the job is complete. To create a job call create_job. Use the set_notification_info method to set notification options at the vault level. You may also supply an Amazon SNS topic to create_job to which Amazon will publish notification about the job status.

You can also call create_job to create an Inventory Retrieval job to list the contents of a vault.

After the job is complete use get_job_output to retrieve the data.

Additionally, multipart uploads are supported through the start_multipart_upload and complete_multipart_upload methods. Various other operations such as delete_archive, get_job_info, list_jobs, list_multipart_uploads, list_vaults, and more provide additional functionality.

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintainted by CloudFiles. Due to this, the AmazonGlacier struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of AmazonGlacier when you have finished using the instance.

Property List

The following is the full list of the properties of the struct with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the struct with short descriptions. Click on the links for further details.

access_key property (AmazonGlacier Struct)

The access key to use for authentication.

Syntax

fn access_key(&self ) -> Result<String, CloudFilesError> 
fn set_access_key(&self, value : &str) ->  Option<CloudFilesError> 
fn set_access_key_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

This property specifies the access key that should be used for authentication. Both this property and secret_key must be set before attempting any operations which connect to the server.

Data Type

String

archive_data property (AmazonGlacier Struct)

Holds the archive data.

Syntax

fn archive_data(&self ) -> Result<Vec<u8>, CloudFilesError> 
fn set_archive_data(&self, value : Vec<u8>) ->  Option<CloudFilesError> 
fn set_archive_data_ref(&self, value : &[u8]) ->  Option<CloudFilesError> 

Default Value

""

Remarks

This property holds the archive data. It is populated after calling get_job_output when the job is an archive retrieval. It may be set to archive data before calling upload_archive.

Data Type

Vec

encryption_algorithm property (AmazonGlacier Struct)

The encryption algorithm.

Syntax

fn encryption_algorithm(&self ) -> Result<i32, CloudFilesError> 
fn set_encryption_algorithm(&self, value : i32) ->  Option<CloudFilesError> 

Possible Values

0   // AES
1   // Blowfish
2   // CAST
3   // DES
4   // IDEA
5   // RC2
6   // RC4
7   // TEA
8   // TripleDES
9   // Twofish
10   // Rijndael
11   // ChaCha
12   // XSalsa20

Default Value

0

Remarks

This property specifies the encryption algorithm to be used. The maximum allowable key size is automatically used for the selected algorithm. Possible values are:

Data Type

i32

encryption_password property (AmazonGlacier Struct)

The encryption password.

Syntax

fn encryption_password(&self ) -> Result<String, CloudFilesError> 
fn set_encryption_password(&self, value : &str) ->  Option<CloudFilesError> 
fn set_encryption_password_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

If this property is populated when upload_file or download_file is called, the struct will attempt to encrypt or decrypt the data before uploading or after downloading it.

The struct uses the value specified here to generate the necessary encryption Key and IV values using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing Key and IV values directly.

However, it is also possible to explicitly specify the Key and IV values to use by setting the EncryptionKey and EncryptionIV configuration settings. This may be necessary if, e.g., the data needs to be encrypted/decrypted by another utility which generates Key and IV values differently.

Data Type

String

firewall_auto_detect property (AmazonGlacier Struct)

Whether to automatically detect and use firewall system settings, if available.

Syntax

fn firewall_auto_detect(&self ) -> Result<bool, CloudFilesError> 
fn set_firewall_auto_detect(&self, value : bool) ->  Option<CloudFilesError> 

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

bool

firewall_type property (AmazonGlacier Struct)

The type of firewall to connect through.

Syntax

fn firewall_type(&self ) -> Result<i32, CloudFilesError> 
fn set_firewall_type(&self, value : i32) ->  Option<CloudFilesError> 

Possible Values

0   // None
1   // Tunnel
2   // SOCKS4
3   // SOCKS5
10   // SOCKS4A

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

i32

firewall_host property (AmazonGlacier Struct)

The name or IP address of the firewall (optional).

Syntax

fn firewall_host(&self ) -> Result<String, CloudFilesError> 
fn set_firewall_host(&self, value : &str) ->  Option<CloudFilesError> 
fn set_firewall_host_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a firewall_host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the struct fails with an error.

Data Type

String

firewall_password property (AmazonGlacier Struct)

A password if authentication is to be used when connecting through the firewall.

Syntax

fn firewall_password(&self ) -> Result<String, CloudFilesError> 
fn set_firewall_password(&self, value : &str) ->  Option<CloudFilesError> 
fn set_firewall_password_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error.

Data Type

String

firewall_port property (AmazonGlacier Struct)

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

fn firewall_port(&self ) -> Result<i32, CloudFilesError> 
fn set_firewall_port(&self, value : i32) ->  Option<CloudFilesError> 

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.

NOTE: This property is set automatically when firewall_firewall_type is set to a valid value. See the description of the firewall_firewall_type property for details.

Data Type

i32

firewall_user property (AmazonGlacier Struct)

A username if authentication is to be used when connecting through a firewall.

Syntax

fn firewall_user(&self ) -> Result<String, CloudFilesError> 
fn set_firewall_user(&self, value : &str) ->  Option<CloudFilesError> 
fn set_firewall_user_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If firewall_host is specified, this property and the firewall_password property are used to connect and authenticate to the given Firewall. If the authentication fails, the struct fails with an error.

Data Type

String

idle property (AmazonGlacier Struct)

The current status of the struct.

Syntax

fn idle(&self ) -> Result<bool, CloudFilesError> 

Default Value

true

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

bool

inventory_data property (AmazonGlacier Struct)

Holds the inventory data.

Syntax

fn inventory_data(&self ) -> Result<Vec<u8>, CloudFilesError> 

Default Value

""

Remarks

This property holds the inventory data and is populated after calling get_job_output if the job is an inventory retrieval job.

This property is read-only.

Data Type

Vec

job_marker property (AmazonGlacier Struct)

A marker used to get the next page of results.

Syntax

fn job_marker(&self ) -> Result<String, CloudFilesError> 
fn set_job_marker(&self, value : &str) ->  Option<CloudFilesError> 
fn set_job_marker_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

This property is populated after calling list_jobs if the results are paged. This property holds the marker that will be sent in the next call to list_jobs to get the next page of results.

Data Type

String

job_count property (AmazonGlacier Struct)

The number of records in the Job arrays.

Syntax

fn job_count(&self ) -> Result<i32, CloudFilesError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• job_archive_id
• job_archive_sha256_tree_hash
• job_archive_size
• job_completed
• job_completion_date
• job_creation_date
• job_description
• job_id
• job_inventory_size
• job_sha256_tree_hash
• job_sns_topic
• job_status_code
• job_status_message
• job_type
• job_vault_arn

The array indices start at 0 and end at job_count - 1.

This property is read-only.

Data Type

i32

job_archive_id property (AmazonGlacier Struct)

This property is populated with the ArchiveId associated with the Job.

Syntax

fn job_archive_id(&self , JobIndex : i32) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

This property is populated with the ArchiveId associated with the Job.

This is only applicable when job_type is 0 (archive retrieval).

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only.

Data Type

String

job_archive_sha256_tree_hash property (AmazonGlacier Struct)

The SHA256 tree hash of the entire archive for an archive retrieval job.

Syntax

fn job_archive_sha256_tree_hash(&self , JobIndex : i32) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The SHA256 tree hash of the entire archive for an archive retrieval job.

This is only applicable when job_type is 0 (archive retrieval).

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only.

Data Type

String

job_archive_size property (AmazonGlacier Struct)

The size of the archive in bytes.

Syntax

fn job_archive_size(&self , JobIndex : i32) -> Result<i64, CloudFilesError> 

Default Value

0

Remarks

The size of the archive in bytes.

This is only applicable when job_type is 0 (archive retrieval).

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only.

Data Type

i64

job_completed property (AmazonGlacier Struct)

Indicates the completion status of the job.

Syntax

fn job_completed(&self , JobIndex : i32) -> Result<bool, CloudFilesError> 

Default Value

false

Remarks

Indicates the completion status of the job. By default both incomplete jobs and recently completed jobs are returned when calling list_jobs. See JobCompletionFilter for more options.

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only.

Data Type

bool

job_completion_date property (AmazonGlacier Struct)

The UTC time that the job completed.

Syntax

fn job_completion_date(&self , JobIndex : i32) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The UTC time that the job completed.

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only.

Data Type

String

job_creation_date property (AmazonGlacier Struct)

The UTC time that the job was created.

Syntax

fn job_creation_date(&self , JobIndex : i32) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The UTC time that the job was created. This is a string representation of ISO 8601 date format, for example: "2012-03-20T17:03:43.221Z".

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only.

Data Type

String

job_description property (AmazonGlacier Struct)

The user supplied description.

Syntax

fn job_description(&self , JobIndex : i32) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The user supplied description. This is specified by the JobDescription setting before calling create_job.

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only.

Data Type

String

job_inventory_size property (AmazonGlacier Struct)

The size in bytes of the inventory data.

Syntax

fn job_inventory_size(&self , JobIndex : i32) -> Result<i64, CloudFilesError> 

Default Value

0

Remarks

The size in bytes of the inventory data. This is only applicable when job_type is 1 (inventory retrieval).

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only.

Data Type

i64

job_id property (AmazonGlacier Struct)

The Amazon assigned JobId.

Syntax

fn job_id(&self , JobIndex : i32) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The Amazon assigned JobId.

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only.

Data Type

String

job_sha256_tree_hash property (AmazonGlacier Struct)

The SHA256 tree hash value for the requested range of an archive.

Syntax

fn job_sha256_tree_hash(&self , JobIndex : i32) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The SHA256 tree hash value for the requested range of an archive. This is only applicable when job_type is 0 (archive retrieval) and a JobRetrievalByteRange is set to a tree-hash aligned range.

When the whole archive is retrieved this values is the same as job_archive_sha256_tree_hash.

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only.

Data Type

String

job_sns_topic property (AmazonGlacier Struct)

The Amazon SNS topic that will receive notifications about the job status.

Syntax

fn job_sns_topic(&self , JobIndex : i32) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The Amazon SNS topic that will receive notifications about the job status.

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only.

Data Type

String

job_status_code property (AmazonGlacier Struct)

The current status of the job.

Syntax

fn job_status_code(&self , JobIndex : i32) -> Result<i32, CloudFilesError> 

Possible Values

0   // None
1   // InProgress
2   // Succeeded
3   // Failed

Default Value

0

Remarks

The current status of the job. Possible values are:

• jsNone (0)
• jsInProgress (1)
• jsSucceeded (2)
• jsFailed (3)

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only.

Data Type

i32

job_status_message property (AmazonGlacier Struct)

A user friendly description of the status.

Syntax

fn job_status_message(&self , JobIndex : i32) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

A user friendly description of the status.

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only.

Data Type

String

job_type property (AmazonGlacier Struct)

The type of the current job.

Syntax

fn job_type(&self , JobIndex : i32) -> Result<i32, CloudFilesError> 

Possible Values

0   // ArchiveRetrieval
1   // InventoryRetrieval

Default Value

0

Remarks

The type of the current job. Possible values are:

• jtArchiveRetrieval (0)
• jtInventoryRetrieval (1)

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only.

Data Type

i32

job_vault_arn property (AmazonGlacier Struct)

The Amazon Resource Name (ARN) of the vault from which the archive retrieval or inventory retrieval was requested.

Syntax

fn job_vault_arn(&self , JobIndex : i32) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The Amazon Resource Name (ARN) of the vault from which the archive retrieval or inventory retrieval was requested.

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only.

Data Type

String

local_file property (AmazonGlacier Struct)

The path to a local file for uploading or downloading.

Syntax

fn local_file(&self ) -> Result<String, CloudFilesError> 
fn set_local_file(&self, value : &str) ->  Option<CloudFilesError> 
fn set_local_file_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

This property is used to specify a local file that will be used for uploading or downloading. Set this to a local file before calling get_job_output. Set this to a local file to upload before calling upload_archive.

Data Type

String

local_host property (AmazonGlacier Struct)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

fn local_host(&self ) -> Result<String, CloudFilesError> 
fn set_local_host(&self, value : &str) ->  Option<CloudFilesError> 
fn set_local_host_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the struct is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

NOTE: local_host is not persistent. You must always set it in code, and never in the property window.

Data Type

String

multipart_upload_marker property (AmazonGlacier Struct)

A marker used to get the next page of results.

Syntax

fn multipart_upload_marker(&self ) -> Result<String, CloudFilesError> 
fn set_multipart_upload_marker(&self, value : &str) ->  Option<CloudFilesError> 
fn set_multipart_upload_marker_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

This property is populated after calling list_multipart_uploads if the results are paged. This property holds the marker that will be sent in the next call to list_multipart_uploads to get the next page of results.

Data Type

String

multipart_upload_count property (AmazonGlacier Struct)

The number of records in the MultipartUpload arrays.

Syntax

fn multipart_upload_count(&self ) -> Result<i32, CloudFilesError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• multipart_upload_archive_description
• multipart_upload_creation_date
• multipart_upload_id
• multipart_upload_part_size
• multipart_upload_vault_arn

The array indices start at 0 and end at multipart_upload_count - 1.

This property is read-only.

Data Type

i32

multipart_upload_archive_description property (AmazonGlacier Struct)

The description of the archive (if any).

Syntax

fn multipart_upload_archive_description(&self , MultipartUploadIndex : i32) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The description of the archive (if any).

The MultipartUploadIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartUploadCount property.

This property is read-only.

Data Type

String

multipart_upload_creation_date property (AmazonGlacier Struct)

The UTC time that the multipart upload was started.

Syntax

fn multipart_upload_creation_date(&self , MultipartUploadIndex : i32) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The UTC time that the multipart upload was started. This is a string representation of ISO 8601 date format. For example: "2012-03-20T17:03:43.221Z".

The MultipartUploadIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartUploadCount property.

This property is read-only.

Data Type

String

multipart_upload_part_size property (AmazonGlacier Struct)

The part size in bytes.

Syntax

fn multipart_upload_part_size(&self , MultipartUploadIndex : i32) -> Result<i32, CloudFilesError> 

Default Value

0

Remarks

The part size in bytes. This is specified by the PartSize setting and is used when start_multipart_upload is called.

The MultipartUploadIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartUploadCount property.

This property is read-only.

Data Type

i32

multipart_upload_id property (AmazonGlacier Struct)

The Id of the multipart upload.

Syntax

fn multipart_upload_id(&self , MultipartUploadIndex : i32) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The Id of the multipart upload.

The MultipartUploadIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartUploadCount property.

This property is read-only.

Data Type

String

multipart_upload_vault_arn property (AmazonGlacier Struct)

The Amazon Resource Name (ARN) of the Vault in which the archive is created.

Syntax

fn multipart_upload_vault_arn(&self , MultipartUploadIndex : i32) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The Amazon Resource Name (ARN) of the Vault in which the archive is created.

The MultipartUploadIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartUploadCount property.

This property is read-only.

Data Type

String

notify_event_type property (AmazonGlacier Struct)

This property specifies the type of enabled notifications for the vault.

Syntax

fn notify_event_type(&self ) -> Result<i32, CloudFilesError> 
fn set_notify_event_type(&self, value : i32) ->  Option<CloudFilesError> 

Possible Values

0   // Both
1   // ArchiveRetrievalCompleted
2   // InventoryRetrievalCompleted

Default Value

0

Remarks

This property specifies the type of enabled notifications for the vault. Possible values are:

Data Type

i32

notify_sns_topic property (AmazonGlacier Struct)

This property specifies the Amazon SNS Topic ARN that is used to deliver notifications.

Syntax

fn notify_sns_topic(&self ) -> Result<String, CloudFilesError> 
fn set_notify_sns_topic(&self, value : &str) ->  Option<CloudFilesError> 
fn set_notify_sns_topic_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

This property specifies the Amazon SNS Topic ARN that is used to deliver notifications. The topic must already exist.

Data Type

String

other_headers property (AmazonGlacier Struct)

Other headers as determined by the user (optional).

Syntax

fn other_headers(&self ) -> Result<String, CloudFilesError> 
fn set_other_headers(&self, value : &str) ->  Option<CloudFilesError> 
fn set_other_headers_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like content_type and from.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the struct beyond what is provided.

Data Type

String

overwrite property (AmazonGlacier Struct)

Whether or not the struct should overwrite files during transfer.

Syntax

fn overwrite(&self ) -> Result<bool, CloudFilesError> 
fn set_overwrite(&self, value : bool) ->  Option<CloudFilesError> 

Default Value

false

Remarks

This property is a indicates whether or not the struct should overwrite downloaded data. If overwrite is false, the struct fails with an error whenever local_file exists and get_job_output is called.

Data Type

bool

parsed_header_count property (AmazonGlacier Struct)

The number of records in the ParsedHeader arrays.

Syntax

fn parsed_header_count(&self ) -> Result<i32, CloudFilesError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• parsed_header_field
• parsed_header_value

The array indices start at 0 and end at parsed_header_count - 1.

This property is read-only.

Data Type

i32

parsed_header_field property (AmazonGlacier Struct)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

fn parsed_header_field(&self , ParsedHeaderIndex : i32) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only.

Data Type

String

parsed_header_value property (AmazonGlacier Struct)

This property contains the header contents.

Syntax

fn parsed_header_value(&self , ParsedHeaderIndex : i32) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

This property contains the Header contents.

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only.

Data Type

String

part_marker property (AmazonGlacier Struct)

A marker used to get the next page of results.

Syntax

fn part_marker(&self ) -> Result<String, CloudFilesError> 
fn set_part_marker(&self, value : &str) ->  Option<CloudFilesError> 
fn set_part_marker_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

This property is populated after calling list_parts if the results are paged. This property holds the marker that will be sent in the next call to list_parts to get the next page of results.

Data Type

String

part_count property (AmazonGlacier Struct)

The number of records in the Part arrays.

Syntax

fn part_count(&self ) -> Result<i32, CloudFilesError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• part_archive_description
• part_creation_date
• part_sha256_tree_hash
• part_size
• part_start_position
• part_upload_id
• part_vault_arn

The array indices start at 0 and end at part_count - 1.

This property is read-only.

Data Type

i32

part_archive_description property (AmazonGlacier Struct)

The description of the archive (if any).

Syntax

fn part_archive_description(&self , PartIndex : i32) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The description of the archive (if any).

The PartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is read-only.

Data Type

String

part_creation_date property (AmazonGlacier Struct)

The UTC time that the multipart upload was started.

Syntax

fn part_creation_date(&self , PartIndex : i32) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The UTC time that the multipart upload was started. This is a string representation of ISO 8601 date format. For example: "2012-03-20T17:03:43.221Z".

The PartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is read-only.

Data Type

String

part_sha256_tree_hash property (AmazonGlacier Struct)

The SHA256 tree hash value that Amazon calculated for the part.

Syntax

fn part_sha256_tree_hash(&self , PartIndex : i32) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The SHA256 tree hash value that Amazon calculated for the part.

The PartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is read-only.

Data Type

String

part_size property (AmazonGlacier Struct)

The part size in bytes.

Syntax

fn part_size(&self , PartIndex : i32) -> Result<i64, CloudFilesError> 

Default Value

0

Remarks

The part size in bytes.

The PartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is read-only.

Data Type

i64

part_start_position property (AmazonGlacier Struct)

The byte offset in the archive of the current part.

Syntax

fn part_start_position(&self , PartIndex : i32) -> Result<i64, CloudFilesError> 

Default Value

0

Remarks

The byte offset in the archive of the current part.

The PartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is read-only.

Data Type

i64

part_upload_id property (AmazonGlacier Struct)

The Id of the multipart upload associated with this part.

Syntax

fn part_upload_id(&self , PartIndex : i32) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The Id of the multipart upload associated with this part.

The PartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is read-only.

Data Type

String

part_vault_arn property (AmazonGlacier Struct)

The Amazon Resource Name (ARN) of the Vault in which the archive is created.

Syntax

fn part_vault_arn(&self , PartIndex : i32) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The Amazon Resource Name (ARN) of the Vault in which the archive is created.

The PartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is read-only.

Data Type

String

proxy_auth_scheme property (AmazonGlacier Struct)

The type of authorization to perform when connecting to the proxy.

Syntax

fn proxy_auth_scheme(&self ) -> Result<i32, CloudFilesError> 
fn set_proxy_auth_scheme(&self, value : i32) ->  Option<CloudFilesError> 

Possible Values

0   // Basic
1   // Digest
2   // Proprietary
3   // None
4   // Ntlm
5   // Negotiate

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.

proxy_auth_scheme should be set to authNone (3) when no authentication is expected.

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the struct will attempt basic authentication.

If proxy_auth_scheme is set to authDigest (1), digest authentication will be attempted instead.

If proxy_auth_scheme is set to authProprietary (2), then the authorization token will not be generated by the struct. Look at the configuration file for the struct being used to find more information about manually setting this token.

If proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

Data Type

i32

proxy_auto_detect property (AmazonGlacier Struct)

Whether to automatically detect and use proxy system settings, if available.

Syntax

fn proxy_auto_detect(&self ) -> Result<bool, CloudFilesError> 
fn set_proxy_auto_detect(&self, value : bool) ->  Option<CloudFilesError> 

Default Value

false

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

bool

proxy_password property (AmazonGlacier Struct)

A password if authentication is to be used for the proxy.

Syntax

fn proxy_password(&self ) -> Result<String, CloudFilesError> 
fn set_proxy_password(&self, value : &str) ->  Option<CloudFilesError> 
fn set_proxy_password_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

A password if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

Data Type

String

proxy_port property (AmazonGlacier Struct)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

fn proxy_port(&self ) -> Result<i32, CloudFilesError> 
fn set_proxy_port(&self, value : i32) ->  Option<CloudFilesError> 

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy proxy_server (default 80). See the description of the proxy_server property for details.

Data Type

i32

proxy_server property (AmazonGlacier Struct)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

fn proxy_server(&self ) -> Result<String, CloudFilesError> 
fn set_proxy_server(&self, value : &str) ->  Option<CloudFilesError> 
fn set_proxy_server_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

If a proxy proxy_server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the proxy_server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the proxy_server property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

proxy_ssl property (AmazonGlacier Struct)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

fn proxy_ssl(&self ) -> Result<i32, CloudFilesError> 
fn set_proxy_ssl(&self, value : i32) ->  Option<CloudFilesError> 

Possible Values

0   // Automatic
1   // Always
2   // Never
3   // Tunnel

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

i32

proxy_user property (AmazonGlacier Struct)

A username if authentication is to be used for the proxy.

Syntax

fn proxy_user(&self ) -> Result<String, CloudFilesError> 
fn set_proxy_user(&self, value : &str) ->  Option<CloudFilesError> 
fn set_proxy_user_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

A username if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

Data Type

String

region property (AmazonGlacier Struct)

The region the struct will make requests against.

Syntax

fn region(&self ) -> Result<String, CloudFilesError> 
fn set_region(&self, value : &str) ->  Option<CloudFilesError> 
fn set_region_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

"us-east-1"

Remarks

This property controls which region the struct will make requests against. By default the struct uses us-east-1, the US East (N. Virginia) region. This property should be changed to create or access resources in other regions.

Regions:

The struct will always convert this property's value to lowercase. If this property is cleared, the struct will reset it to the default value.

Data Type

String

secret_key property (AmazonGlacier Struct)

The secret key to use for authentication.

Syntax

fn secret_key(&self ) -> Result<String, CloudFilesError> 
fn set_secret_key(&self, value : &str) ->  Option<CloudFilesError> 
fn set_secret_key_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

This property specifies the secret key that should be used for authentication. Both this property and access_key must be set before attempting any operations which connect to the server.

Data Type

String

ssl_accept_server_cert_effective_date property (AmazonGlacier Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_accept_server_cert_effective_date(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_accept_server_cert_expiration_date property (AmazonGlacier Struct)

The date on which the certificate expires.

Syntax

fn ssl_accept_server_cert_expiration_date(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_accept_server_cert_extended_key_usage property (AmazonGlacier Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_accept_server_cert_extended_key_usage(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint property (AmazonGlacier Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint_sha1 property (AmazonGlacier Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint_sha1(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint_sha256 property (AmazonGlacier Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint_sha256(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

ssl_accept_server_cert_issuer property (AmazonGlacier Struct)

The issuer of the certificate.

Syntax

fn ssl_accept_server_cert_issuer(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

ssl_accept_server_cert_private_key property (AmazonGlacier Struct)

The private key of the certificate (if available).

Syntax

fn ssl_accept_server_cert_private_key(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The ssl_accept_server_cert_private_key may be available but not exportable. In this case, ssl_accept_server_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_accept_server_cert_private_key_available property (AmazonGlacier Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_accept_server_cert_private_key_available(&self ) -> Result<bool, CloudFilesError> 

Default Value

false

Remarks

Whether a ssl_accept_server_cert_private_key is available for the selected certificate. If ssl_accept_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_accept_server_cert_private_key_container property (AmazonGlacier Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_accept_server_cert_private_key_container(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The name of the ssl_accept_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key property (AmazonGlacier Struct)

The public key of the certificate.

Syntax

fn ssl_accept_server_cert_public_key(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key_algorithm property (AmazonGlacier Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_accept_server_cert_public_key_algorithm(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key_length property (AmazonGlacier Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_accept_server_cert_public_key_length(&self ) -> Result<i32, CloudFilesError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

ssl_accept_server_cert_serial_number property (AmazonGlacier Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_accept_server_cert_serial_number(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

ssl_accept_server_cert_signature_algorithm property (AmazonGlacier Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_accept_server_cert_signature_algorithm(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_accept_server_cert_store property (AmazonGlacier Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_accept_server_cert_store(&self ) -> Result<Vec<u8>, CloudFilesError> 
fn set_ssl_accept_server_cert_store(&self, value : Vec<u8>) ->  Option<CloudFilesError> 
fn set_ssl_accept_server_cert_store_ref(&self, value : &[u8]) ->  Option<CloudFilesError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_accept_server_cert_store_type property denotes the type of the certificate store specified by ssl_accept_server_cert_store. If the store is password-protected, specify the password in ssl_accept_server_cert_store_password.

ssl_accept_server_cert_store is used in conjunction with the ssl_accept_server_cert_subject property to specify client certificates. If ssl_accept_server_cert_store has a value, and ssl_accept_server_cert_subject or ssl_accept_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_accept_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Vec

ssl_accept_server_cert_store_password property (AmazonGlacier Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_accept_server_cert_store_password(&self ) -> Result<String, CloudFilesError> 
fn set_ssl_accept_server_cert_store_password(&self, value : &str) ->  Option<CloudFilesError> 
fn set_ssl_accept_server_cert_store_password_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

ssl_accept_server_cert_store_type property (AmazonGlacier Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_accept_server_cert_store_type(&self ) -> Result<i32, CloudFilesError> 
fn set_ssl_accept_server_cert_store_type(&self, value : i32) ->  Option<CloudFilesError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

i32

ssl_accept_server_cert_subject_alt_names property (AmazonGlacier Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_accept_server_cert_subject_alt_names(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_md5 property (AmazonGlacier Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_md5(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_sha1 property (AmazonGlacier Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_sha1(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_sha256 property (AmazonGlacier Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_sha256(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_accept_server_cert_usage property (AmazonGlacier Struct)

The text description of UsageFlags .

Syntax

fn ssl_accept_server_cert_usage(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The text description of ssl_accept_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

ssl_accept_server_cert_usage_flags property (AmazonGlacier Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_accept_server_cert_usage_flags(&self ) -> Result<i32, CloudFilesError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_accept_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_accept_server_cert_usage property for a text representation of ssl_accept_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_accept_server_cert_version property (AmazonGlacier Struct)

The certificate's version number.

Syntax

fn ssl_accept_server_cert_version(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

ssl_accept_server_cert_subject property (AmazonGlacier Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_accept_server_cert_subject(&self ) -> Result<String, CloudFilesError> 
fn set_ssl_accept_server_cert_subject(&self, value : &str) ->  Option<CloudFilesError> 
fn set_ssl_accept_server_cert_subject_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

ssl_accept_server_cert_encoded property (AmazonGlacier Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_accept_server_cert_encoded(&self ) -> Result<Vec<u8>, CloudFilesError> 
fn set_ssl_accept_server_cert_encoded(&self, value : Vec<u8>) ->  Option<CloudFilesError> 
fn set_ssl_accept_server_cert_encoded_ref(&self, value : &[u8]) ->  Option<CloudFilesError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.

Data Type

Vec

ssl_cert_effective_date property (AmazonGlacier Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_cert_effective_date(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_cert_expiration_date property (AmazonGlacier Struct)

The date on which the certificate expires.

Syntax

fn ssl_cert_expiration_date(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_cert_extended_key_usage property (AmazonGlacier Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_cert_extended_key_usage(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

ssl_cert_fingerprint property (AmazonGlacier Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

ssl_cert_fingerprint_sha1 property (AmazonGlacier Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint_sha1(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

ssl_cert_fingerprint_sha256 property (AmazonGlacier Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint_sha256(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

ssl_cert_issuer property (AmazonGlacier Struct)

The issuer of the certificate.

Syntax

fn ssl_cert_issuer(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

ssl_cert_private_key property (AmazonGlacier Struct)

The private key of the certificate (if available).

Syntax

fn ssl_cert_private_key(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The ssl_cert_private_key may be available but not exportable. In this case, ssl_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_cert_private_key_available property (AmazonGlacier Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_cert_private_key_available(&self ) -> Result<bool, CloudFilesError> 

Default Value

false

Remarks

Whether a ssl_cert_private_key is available for the selected certificate. If ssl_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_cert_private_key_container property (AmazonGlacier Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_cert_private_key_container(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The name of the ssl_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_cert_public_key property (AmazonGlacier Struct)

The public key of the certificate.

Syntax

fn ssl_cert_public_key(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

ssl_cert_public_key_algorithm property (AmazonGlacier Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_cert_public_key_algorithm(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_cert_public_key_length property (AmazonGlacier Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_cert_public_key_length(&self ) -> Result<i32, CloudFilesError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

ssl_cert_serial_number property (AmazonGlacier Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_cert_serial_number(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

ssl_cert_signature_algorithm property (AmazonGlacier Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_cert_signature_algorithm(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_cert_store property (AmazonGlacier Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_cert_store(&self ) -> Result<Vec<u8>, CloudFilesError> 
fn set_ssl_cert_store(&self, value : Vec<u8>) ->  Option<CloudFilesError> 
fn set_ssl_cert_store_ref(&self, value : &[u8]) ->  Option<CloudFilesError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password-protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Vec

ssl_cert_store_password property (AmazonGlacier Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_cert_store_password(&self ) -> Result<String, CloudFilesError> 
fn set_ssl_cert_store_password(&self, value : &str) ->  Option<CloudFilesError> 
fn set_ssl_cert_store_password_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

ssl_cert_store_type property (AmazonGlacier Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_cert_store_type(&self ) -> Result<i32, CloudFilesError> 
fn set_ssl_cert_store_type(&self, value : i32) ->  Option<CloudFilesError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

i32

ssl_cert_subject_alt_names property (AmazonGlacier Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_cert_subject_alt_names(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_md5 property (AmazonGlacier Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_md5(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_sha1 property (AmazonGlacier Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha1(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_sha256 property (AmazonGlacier Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha256(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_usage property (AmazonGlacier Struct)

The text description of UsageFlags .

Syntax

fn ssl_cert_usage(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The text description of ssl_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

ssl_cert_usage_flags property (AmazonGlacier Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_cert_usage_flags(&self ) -> Result<i32, CloudFilesError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_cert_usage_flags is a combination of the following flags:

Please see the ssl_cert_usage property for a text representation of ssl_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_cert_version property (AmazonGlacier Struct)

The certificate's version number.

Syntax

fn ssl_cert_version(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

ssl_cert_subject property (AmazonGlacier Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_cert_subject(&self ) -> Result<String, CloudFilesError> 
fn set_ssl_cert_subject(&self, value : &str) ->  Option<CloudFilesError> 
fn set_ssl_cert_subject_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

ssl_cert_encoded property (AmazonGlacier Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_cert_encoded(&self ) -> Result<Vec<u8>, CloudFilesError> 
fn set_ssl_cert_encoded(&self, value : Vec<u8>) ->  Option<CloudFilesError> 
fn set_ssl_cert_encoded_ref(&self, value : &[u8]) ->  Option<CloudFilesError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

Data Type

Vec

ssl_provider property (AmazonGlacier Struct)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

fn ssl_provider(&self ) -> Result<i32, CloudFilesError> 
fn set_ssl_provider(&self, value : i32) ->  Option<CloudFilesError> 

Possible Values

0   // Automatic
1   // Platform
2   // Internal

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the struct will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The struct will select a provider depending on the current platform.

When Automatic is selected, on Windows, the struct will use the platform implementation. On Linux/macOS, the struct will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

i32

ssl_server_cert_effective_date property (AmazonGlacier Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_server_cert_effective_date(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_server_cert_expiration_date property (AmazonGlacier Struct)

The date on which the certificate expires.

Syntax

fn ssl_server_cert_expiration_date(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_server_cert_extended_key_usage property (AmazonGlacier Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_server_cert_extended_key_usage(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint property (AmazonGlacier Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint_sha1 property (AmazonGlacier Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint_sha1(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint_sha256 property (AmazonGlacier Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint_sha256(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

ssl_server_cert_issuer property (AmazonGlacier Struct)

The issuer of the certificate.

Syntax

fn ssl_server_cert_issuer(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

ssl_server_cert_private_key property (AmazonGlacier Struct)

The private key of the certificate (if available).

Syntax

fn ssl_server_cert_private_key(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The ssl_server_cert_private_key may be available but not exportable. In this case, ssl_server_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_server_cert_private_key_available property (AmazonGlacier Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_server_cert_private_key_available(&self ) -> Result<bool, CloudFilesError> 

Default Value

false

Remarks

Whether a ssl_server_cert_private_key is available for the selected certificate. If ssl_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_server_cert_private_key_container property (AmazonGlacier Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_server_cert_private_key_container(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The name of the ssl_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_server_cert_public_key property (AmazonGlacier Struct)

The public key of the certificate.

Syntax

fn ssl_server_cert_public_key(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

ssl_server_cert_public_key_algorithm property (AmazonGlacier Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_server_cert_public_key_algorithm(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_server_cert_public_key_length property (AmazonGlacier Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_server_cert_public_key_length(&self ) -> Result<i32, CloudFilesError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

ssl_server_cert_serial_number property (AmazonGlacier Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_server_cert_serial_number(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

ssl_server_cert_signature_algorithm property (AmazonGlacier Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_server_cert_signature_algorithm(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_server_cert_store property (AmazonGlacier Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_server_cert_store(&self ) -> Result<Vec<u8>, CloudFilesError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_server_cert_store_type property denotes the type of the certificate store specified by ssl_server_cert_store. If the store is password-protected, specify the password in ssl_server_cert_store_password.

ssl_server_cert_store is used in conjunction with the ssl_server_cert_subject property to specify client certificates. If ssl_server_cert_store has a value, and ssl_server_cert_subject or ssl_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Vec

ssl_server_cert_store_password property (AmazonGlacier Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_server_cert_store_password(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

Data Type

String

ssl_server_cert_store_type property (AmazonGlacier Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_server_cert_store_type(&self ) -> Result<i32, CloudFilesError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

This property is read-only.

Data Type

i32

ssl_server_cert_subject_alt_names property (AmazonGlacier Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_server_cert_subject_alt_names(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_md5 property (AmazonGlacier Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_md5(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_sha1 property (AmazonGlacier Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_sha1(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_sha256 property (AmazonGlacier Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_sha256(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_server_cert_usage property (AmazonGlacier Struct)

The text description of UsageFlags .

Syntax

fn ssl_server_cert_usage(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The text description of ssl_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

ssl_server_cert_usage_flags property (AmazonGlacier Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_server_cert_usage_flags(&self ) -> Result<i32, CloudFilesError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_server_cert_usage property for a text representation of ssl_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_server_cert_version property (AmazonGlacier Struct)

The certificate's version number.

Syntax

fn ssl_server_cert_version(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

ssl_server_cert_subject property (AmazonGlacier Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_server_cert_subject(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

Data Type

String

ssl_server_cert_encoded property (AmazonGlacier Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_server_cert_encoded(&self ) -> Result<Vec<u8>, CloudFilesError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.

This property is read-only.

Data Type

Vec

timeout property (AmazonGlacier Struct)

The timeout for the struct.

Syntax

fn timeout(&self ) -> Result<i32, CloudFilesError> 
fn set_timeout(&self, value : i32) ->  Option<CloudFilesError> 

Default Value

60

Remarks

If the timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If timeout is set to a positive value, the struct will wait for the operation to complete before returning control.

The struct will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If timeout expires, and the operation is not yet complete, the struct fails with an error.

NOTE: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.

The default value for the timeout property is 60 seconds.

Data Type

i32

use_ssl property (AmazonGlacier Struct)

Whether to use SSL/TLS when connecting.

Syntax

fn use_ssl(&self ) -> Result<bool, CloudFilesError> 
fn set_use_ssl(&self, value : bool) ->  Option<CloudFilesError> 

Default Value

true

Remarks

This property specifies whether the struct should use SSL/TLS when connecting.

Data Type

bool

vault_marker property (AmazonGlacier Struct)

A marker used to get the next page of results.

Syntax

fn vault_marker(&self ) -> Result<String, CloudFilesError> 
fn set_vault_marker(&self, value : &str) ->  Option<CloudFilesError> 
fn set_vault_marker_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

This property is populated after calling list_vaults if the results are paged. This property holds the marker that will be sent in the next call to list_vaults to get the next page of results.

Data Type

String

vault_count property (AmazonGlacier Struct)

The number of records in the Vault arrays.

Syntax

fn vault_count(&self ) -> Result<i32, CloudFilesError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• vault_archive_count
• vault_arn
• vault_creation_date
• vault_last_inventory_date
• vault_name
• vault_size

The array indices start at 0 and end at vault_count - 1.

This property is read-only.

Data Type

i32

vault_archive_count property (AmazonGlacier Struct)

The number of archives in the vault as of LastInventoryDate .

Syntax

fn vault_archive_count(&self , VaultIndex : i32) -> Result<i32, CloudFilesError> 

Default Value

0

Remarks

The number of archives in the vault as of vault_last_inventory_date.

The VaultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the VaultCount property.

This property is read-only.

Data Type

i32

vault_arn property (AmazonGlacier Struct)

The Amazon Resource Name (ARN) of the vault.

Syntax

fn vault_arn(&self , VaultIndex : i32) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The Amazon Resource Name (ARN) of the vault.

The VaultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the VaultCount property.

This property is read-only.

Data Type

String

vault_creation_date property (AmazonGlacier Struct)

The date the vault was created, in Coordinated Universal Time (UTC).

Syntax

fn vault_creation_date(&self , VaultIndex : i32) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The date the vault was created, in Coordinated Universal Time (UTC). This is a string representation of ISO 8601 date format, for example: 2012-03-20T17:03:43.221Z.

The VaultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the VaultCount property.

This property is read-only.

Data Type

String

vault_last_inventory_date property (AmazonGlacier Struct)

The date of the last vault inventory, in Coordinated Universal Time (UTC).

Syntax

fn vault_last_inventory_date(&self , VaultIndex : i32) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The date of the last vault inventory, in Coordinated Universal Time (UTC). This is a string representation of ISO 8601 date format, for example: 2012-03-20T17:03:43.221Z.

The VaultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the VaultCount property.

This property is read-only.

Data Type

String

vault_name property (AmazonGlacier Struct)

The name of the vault.

Syntax

fn vault_name(&self , VaultIndex : i32) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The name of the vault.

The VaultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the VaultCount property.

This property is read-only.

Data Type

String

vault_size property (AmazonGlacier Struct)

The size of all the archives (including any per-archive overhead) in the vault, as of the last inventory date.

Syntax

fn vault_size(&self , VaultIndex : i32) -> Result<i64, CloudFilesError> 

Default Value

0

Remarks

The size of all the archives (including any per-archive overhead) in the vault, as of the last inventory date.

The VaultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the VaultCount property.

This property is read-only.

Data Type

i64

abort_multipart_upload method (AmazonGlacier Struct)

Aborts a multipart upload.

Syntax

fn abort_multipart_upload(&self, vault_name : &str, upload_id : &str) -> Result<(), CloudFilesError>

Remarks

This method aborts a multipart upload specified by UploadId. UploadId is returned from the start_multipart_upload method.

VaultName specifies the vault in which the archive is created.

Only multipart uploads that are not yet completed can be aborted.

complete_multipart_upload method (AmazonGlacier Struct)

Completes a multipart upload.

Syntax

fn complete_multipart_upload(&self, vault_name : &str, upload_id : &str) ->  Result<String, CloudFilesError>

Remarks

This method completes the current multipart upload specified by UploadId.

VaultName specifies the vault in which the archive was created.

This method returns the ArchiveId which identifies the newly created archive. If you call this method twice for the same multipart upload within a short period of time, the same ArchiveId will be returned.

If parts of the archive were uploaded using separate instances of the struct you must first list all parts of the archive by calling list_parts until part_marker is empty (all parts are returned). Information about the parts is required when completing the multipart upload.

config method (AmazonGlacier Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, CloudFilesError>

Remarks

config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

create_job method (AmazonGlacier Struct)

Creates a new job.

Syntax

fn create_job(&self, vault_name : &str, job_type : i32, archive_id : &str, sns_topic : &str) ->  Result<String, CloudFilesError>

Remarks

This method creates a new job. There are two types of jobs, archive retrieval and inventory retrieval. After the job is created this method will return the JobId. Amazon will then execute the job (which may take hours) and then notify you when it is complete.

VaultName specifies the name of the vault.

JobType specifies the operation. Possible values are:

ArchiveId specifies the archive to retrieve when JobType is set to 0 (archive retrieval).

SNSTopic specifies the SNS topic to which the notification will be posted when the operation is complete.

The get_job_info method may be called with the returned JobId to check the status of the job. Once the job is completed use the get_job_output method to retrieve the data.

Note: JobDescription may optionally be set. JobRetrievalByteRange may be set when JobType is 0 (archive retrieval). JobInventoryFormat may be set when JobType is set to 1 (inventory retrieval).

create_vault method (AmazonGlacier Struct)

Creates a new vault.

Syntax

fn create_vault(&self, vault_name : &str) -> Result<(), CloudFilesError>

Remarks

This method creates a new vault with the name specified by the VaultName parameter.

Names can be between 1 and 255 characters long. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period).

The region in which the vault is created is controlled by the region property.

delete_archive method (AmazonGlacier Struct)

Deletes an archive.

Syntax

fn delete_archive(&self, vault_name : &str, archive_id : &str) -> Result<(), CloudFilesError>

Remarks

This method deletes the archive specified by the ArchiveId parameter.

delete_notification_info method (AmazonGlacier Struct)

Deletes the notification information for the vault.

Syntax

fn delete_notification_info(&self, vault_name : &str) -> Result<(), CloudFilesError>

Remarks

This method deletes the notification information associated with the vault specified by VaultName.

delete_vault method (AmazonGlacier Struct)

Deletes the specified vault.

Syntax

fn delete_vault(&self, vault_name : &str) -> Result<(), CloudFilesError>

Remarks

This method deletes the vault specified by VaultName. If the vault is not empty Amazon will return an error.

Call get_vault_info to get information about the archive including the number of archives it contains.

do_events method (AmazonGlacier Struct)

This method processes events from the internal message queue.

Syntax

fn do_events(&self) -> Result<(), CloudFilesError>

Remarks

When do_events is called, the struct processes any available events. If no events are available, it waits for a preset period of time, and then returns.

get_job_info method (AmazonGlacier Struct)

Retrieves information about the specified job.

Syntax

fn get_job_info(&self, vault_name : &str, job_id : &str) -> Result<(), CloudFilesError>

Remarks

This method retrieves information about the job specified by JobId. The jobs collection will be populated with information about the job.

get_job_output method (AmazonGlacier Struct)

Retrieves the output from the job.

Syntax

fn get_job_output(&self, vault_name : &str, job_id : &str) -> Result<(), CloudFilesError>

Remarks

This method retrieves the output from a completed job. If local_file is set, the data will be written to the specified file. If local_file is not set the data will be written to either inventory_data or archive_data depending on the type of job.

get_notification_info method (AmazonGlacier Struct)

Retrieves the notification information for the vault.

Syntax

fn get_notification_info(&self, vault_name : &str) -> Result<(), CloudFilesError>

Remarks

This method retrieves the notification information for the vault specified by VaultName. After this method returns, the results will be available in the notification_info property.

If no notification settings exist for the vault the struct fails with an error.

get_vault_info method (AmazonGlacier Struct)

Retrieves vault details.

Syntax

fn get_vault_info(&self, vault_name : &str) -> Result<(), CloudFilesError>

Remarks

This method gets information about the vault specified by VaultName. The vaults property will be populated with the results. The following properties are populated:

• vault_archive_count
• vault_arn
• vault_creation_date
• vault_last_inventory_date
• vault_name
• vault_size

interrupt method (AmazonGlacier Struct)

This method interrupts the current method.

Syntax

fn interrupt(&self) -> Result<(), CloudFilesError>

Remarks

If there is no method in progress, interrupt simply returns, doing nothing.

list_jobs method (AmazonGlacier Struct)

Lists the jobs in a vault.

Syntax

fn list_jobs(&self, vault_name : &str) -> Result<(), CloudFilesError>

Remarks

This method lists the jobs in the vault specified by VaultName.

The on_job_list event will fire once for each Job returned. In addition, the jobs collection will be populated.

By default up to 1000 jobs will be returned in a single set of results. The maximum number of results can be specified by setting MaxListJobResults. If the number of results exceeds the maximum the results are paged. The IsJobPaged setting will be set to true and job_marker will be populated.

To get all results simply call list_jobs again until IsJobPaged returns False and job_marker is empty string. Alternatively, the AccumulatePages configuration setting can be disabled to clear the jobs properties every time a page of results is returned.

Note: The settings JobCompletionFilter and JobStatusFilter may be set to control what type of jobs are returned.

list_multipart_uploads method (AmazonGlacier Struct)

Lists multipart uploads.

Syntax

fn list_multipart_uploads(&self, vault_name : &str) -> Result<(), CloudFilesError>

Remarks

This method lists the current multipart uploads for the vault specified by VaultName. The on_multipart_upload_list event will fire once for each multipart upload returned. In addition, the multipart_uploads collection will be populated.

By default up to 1000 multipart uploads will be returned in a single set of results. The maximum number of results can be specified by setting MaxListMultipartUploadResults. If the number of results exceeds the maximum the results are paged. The IsMultipartUploadPaged setting will be set to true and multipart_upload_marker will be populated.

To get all results simply call list_multipart_uploads again until IsMultipartUploadPaged returns False and multipart_upload_marker is empty string. Alternatively, the AccumulatePages configuration setting can be disabled to clear the multipart_uploads properties every time a page of results is returned.

list_parts method (AmazonGlacier Struct)

Lists the parts of a multipart upload.

Syntax

fn list_parts(&self, vault_name : &str, upload_id : &str) -> Result<(), CloudFilesError>

Remarks

This method lists the parts of a multipart upload specified by UploadId.

VaultName identifies the vault in which the archive is created.

The on_part_list event will fire once for each Part returned. In addition, the parts collection will be populated.

By default up to 1000 parts will be returned in a single set of results. The maximum number of results can be specified by setting MaxListPartResults. If the number of results exceeds the maximum the results are paged. The IsPartPaged setting will be set to true and part_marker will be populated.

To get all results simply call list_parts again until IsPartPaged returns False and part_marker is empty string. Alternatively, the AccumulatePages configuration setting can be disabled to clear the parts properties every time a page of results is returned.

list_vaults method (AmazonGlacier Struct)

Lists the vaults.

Syntax

fn list_vaults(&self) -> Result<(), CloudFilesError>

Remarks

This method lists the vaults for an account.

By default up to 1000 vaults will be returned in a single set of results. This maximum number of results can be specified by setting MaxListVaultResults. If the number of results exceeds the maximum the results are paged. The IsVaultPaged setting will be set to true and vault_marker will be populated.

To get all results simply call list_vaults again until IsVaultPaged returns False and vault_marker is empty string. Alternatively, the AccumulatePages configuration setting can be disabled to clear the vaults properties every time a page of results is returned.

reset method (AmazonGlacier Struct)

Resets the struct to its initial state.

Syntax

fn reset(&self) -> Result<(), CloudFilesError>

Remarks

This method resets the struct to its initial state.

set_notification_info method (AmazonGlacier Struct)

Sets notification information for a vault.

Syntax

fn set_notification_info(&self, vault_name : &str) -> Result<(), CloudFilesError>

Remarks

This method sets the notification settings for the vault specified by VaultName. The notify_sns_topic property must be set before calling this method. Optionally, the notify_event_type may also be set.

start_multipart_upload method (AmazonGlacier Struct)

Starts a multipart upload.

Syntax

fn start_multipart_upload(&self, vault_name : &str, archive_desc : &str) ->  Result<String, CloudFilesError>

Remarks

This method initiates a multipart upload operation. Multipart uploads are beneficial in situations where you wish to upload a large amount of data, or do not know how large the data will be when you begin uploading.

This method returns an UploadId that must be saved. This will be used to perform other operations with this upload.

ArchiveDesc may be set to a user friendly description of the archive, or empty string.

VaultName is the vault in which the archive will be created.

The data must be split into parts with a size (in megabytes) specified by PartSize. The part size must be a megabyte multiplied by a power of 2. For instance 1, 2, 4, and 8 are valid sizes. The minimum part size is 1, the maximum is 4096 (4GB). The default value of PartSize is 1.

Each part must be exactly PartSize megabytes in size except the last part. The last part will be smaller. For instance with a part size of 1, uploading a 10.2 megabyte file will have 11 parts. There will be 10 parts of size 1 MB, and 1 part of size .2 MB.

Parts may be uploaded in parallel by using separate struct instances. When uploading a part with upload_part a part number is specified so the data can be properly re-assembled in order when it reaches the server.

After all parts are uploaded call complete_multipart_upload to complete the operation. If parts of the archive were uploaded using separate instances of the struct you must first list all parts of the archive by calling ListParts until PartMarker is empty (all parts are returned). Information about the parts is required when completing the multipart upload.

To cancel the operation, call abort_multipart_upload.

upload_archive method (AmazonGlacier Struct)

Uploads an archive to a vault.

Syntax

fn upload_archive(&self, vault_name : &str, archive_desc : &str) ->  Result<String, CloudFilesError>

Remarks

This method uploads an archive to the vault specified by VaultName. If local_file is set, the archive data will be read from the specified file. If local_file is not set, the data set in archive_data will be used.

The ArchiveDesc parameter may be set to a user friendly description of the archive. The description must be less than or equal to 1,024 characters. The allowable characters are 7-bit ASCII without control codes, specifically ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.

This method returns the ArchiveId if the data was successfully uploaded.

upload_part method (AmazonGlacier Struct)

Uploads a single part in a multipart upload.

Syntax

fn upload_part(&self, vault_name : &str, upload_id : &str, part_number : i32) -> Result<(), CloudFilesError>

Remarks

This method uploads a single part of the multipart upload specified by UploadId.

VaultName is the vault in which the archive is created.

PartNumber identifies this specific part. The first part number is 0. Amazon will re-assemble the archive in the order specified by part numbers.

If local_file is set, the part data will be read from the specified file. If local_file is not set, the data set in archive_data will be used.

on_end_transfer event (AmazonGlacier Struct)

This event fires when a document finishes transferring.

Syntax

// AmazonGlacierEndTransferEventArgs carries the AmazonGlacier EndTransfer event's parameters.
pub struct AmazonGlacierEndTransferEventArgs {
  fn direction(&self) -> i32
}

// AmazonGlacierEndTransferEvent defines the signature of the AmazonGlacier EndTransfer event's handler function.
pub trait AmazonGlacierEndTransferEvent {
  fn on_end_transfer(&self, sender : AmazonGlacier, e : &mut AmazonGlacierEndTransferEventArgs);
}

impl <'a> AmazonGlacier<'a> {
  pub fn on_end_transfer(&self) -> &'a dyn AmazonGlacierEndTransferEvent;
  pub fn set_on_end_transfer(&mut self, value : &'a dyn AmazonGlacierEndTransferEvent);
  ...
}

Remarks

The on_end_transfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

on_error event (AmazonGlacier Struct)

Fired when information is available about errors during data delivery.

Syntax

// AmazonGlacierErrorEventArgs carries the AmazonGlacier Error event's parameters.
pub struct AmazonGlacierErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// AmazonGlacierErrorEvent defines the signature of the AmazonGlacier Error event's handler function.
pub trait AmazonGlacierErrorEvent {
  fn on_error(&self, sender : AmazonGlacier, e : &mut AmazonGlacierErrorEventArgs);
}

impl <'a> AmazonGlacier<'a> {
  pub fn on_error(&self) -> &'a dyn AmazonGlacierErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn AmazonGlacierErrorEvent);
  ...
}

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_header event (AmazonGlacier Struct)

Fired every time a header line comes in.

Syntax

// AmazonGlacierHeaderEventArgs carries the AmazonGlacier Header event's parameters.
pub struct AmazonGlacierHeaderEventArgs {
  fn field(&self) -> &String
  fn value(&self) -> &String
}

// AmazonGlacierHeaderEvent defines the signature of the AmazonGlacier Header event's handler function.
pub trait AmazonGlacierHeaderEvent {
  fn on_header(&self, sender : AmazonGlacier, e : &mut AmazonGlacierHeaderEventArgs);
}

impl <'a> AmazonGlacier<'a> {
  pub fn on_header(&self) -> &'a dyn AmazonGlacierHeaderEvent;
  pub fn set_on_header(&mut self, value : &'a dyn AmazonGlacierHeaderEvent);
  ...
}

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

on_job_list event (AmazonGlacier Struct)

Fires once for each job returned when calling ListJobs or GetJobInfo.

Syntax

// AmazonGlacierJobListEventArgs carries the AmazonGlacier JobList event's parameters.
pub struct AmazonGlacierJobListEventArgs {
  fn job_type(&self) -> i32
  fn archive_id(&self) -> &String
  fn archive_size(&self) -> i64
  fn archive_sha256_tree_hash(&self) -> &String
  fn completed(&self) -> bool
  fn completion_date(&self) -> &String
  fn creation_date(&self) -> &String
  fn description(&self) -> &String
  fn job_id(&self) -> &String
  fn sns_topic(&self) -> &String
  fn sha256_tree_hash(&self) -> &String
  fn status_code(&self) -> i32
  fn status_message(&self) -> &String
  fn vault_arn(&self) -> &String
  fn inventory_size(&self) -> i64
}

// AmazonGlacierJobListEvent defines the signature of the AmazonGlacier JobList event's handler function.
pub trait AmazonGlacierJobListEvent {
  fn on_job_list(&self, sender : AmazonGlacier, e : &mut AmazonGlacierJobListEventArgs);
}

impl <'a> AmazonGlacier<'a> {
  pub fn on_job_list(&self) -> &'a dyn AmazonGlacierJobListEvent;
  pub fn set_on_job_list(&mut self, value : &'a dyn AmazonGlacierJobListEvent);
  ...
}

Remarks

This event fires once for each job returned when calling list_jobs. When calling get_job_info this event will fire once since only one job is returned.

JobType indicates the type of job. Possible values are:

ArchiveId is the Id of the archive associated with the job.

ArchiveSize is the size in bytes of the archive.

ArchiveSHA256TreeHash is the SHA256 tree hash of the entire archive for an archive retrieval job.

Completed indicates the status of the job.

CompletionDate is the UTC time that the job completed.

CreationDate is the UTC time that the job was created. This is a string representation of ISO 8601 date format, for example: "2012-03-20T17:03:43.221Z".

Description is the user supplied description. This is specified by the JobDescription setting before calling create_job.

JobId is the Amazon assigned Id for the job.

SNSTopic is the Amazon SNS topic that will receive notification about the job status.

SHA256TreeHash is the SHA256 tree hash value for the requested range of an archive. This is only applicable when JobType is 0 (archive retrieval) and a JobRetrievalByteRange is set to a tree-hash aligned range.

StatusCode is the current status of the job. Possible values are:

StatusMessage is a user friendly description of the status.

VaultArn is the Amazon Resource Name (ARN) of the vault from which the archive retrieval or inventory retrieval was requested.

InventorySize is the size in bytes of the inventory data.

on_log event (AmazonGlacier Struct)

Fired once for each log message.

Syntax

// AmazonGlacierLogEventArgs carries the AmazonGlacier Log event's parameters.
pub struct AmazonGlacierLogEventArgs {
  fn log_level(&self) -> i32
  fn message(&self) -> &String
  fn log_type(&self) -> &String
}

// AmazonGlacierLogEvent defines the signature of the AmazonGlacier Log event's handler function.
pub trait AmazonGlacierLogEvent {
  fn on_log(&self, sender : AmazonGlacier, e : &mut AmazonGlacierLogEventArgs);
}

impl <'a> AmazonGlacier<'a> {
  pub fn on_log(&self) -> &'a dyn AmazonGlacierLogEvent;
  pub fn set_on_log(&mut self, value : &'a dyn AmazonGlacierLogEvent);
  ...
}

Remarks

This event is fired once for each log message generated by the struct. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

on_multipart_upload_list event (AmazonGlacier Struct)

Fires once for each multipart upload when ListMultipartUploads is called.

Syntax

// AmazonGlacierMultipartUploadListEventArgs carries the AmazonGlacier MultipartUploadList event's parameters.
pub struct AmazonGlacierMultipartUploadListEventArgs {
  fn archive_description(&self) -> &String
  fn creation_date(&self) -> &String
  fn upload_id(&self) -> &String
  fn vault_arn(&self) -> &String
  fn part_size(&self) -> i32
}

// AmazonGlacierMultipartUploadListEvent defines the signature of the AmazonGlacier MultipartUploadList event's handler function.
pub trait AmazonGlacierMultipartUploadListEvent {
  fn on_multipart_upload_list(&self, sender : AmazonGlacier, e : &mut AmazonGlacierMultipartUploadListEventArgs);
}

impl <'a> AmazonGlacier<'a> {
  pub fn on_multipart_upload_list(&self) -> &'a dyn AmazonGlacierMultipartUploadListEvent;
  pub fn set_on_multipart_upload_list(&mut self, value : &'a dyn AmazonGlacierMultipartUploadListEvent);
  ...
}

Remarks

This event fires for each multipart upload returned when calling list_multipart_uploads.

ArchiveDescription is the archive description (if any).

CreationDate is the UTC time that the multipart upload was started. This is a string representation of ISO 8601 date format. For example: "2012-03-20T17:03:43.221Z".

UploadId is the Id of the multipart upload.

VaultArn is the Amazon Resource Name (ARN) of the Vault in which the archive is created.

PartSize is the part size in bytes. This is specified by the PartSize setting and is used when start_multipart_upload is called.

on_part_list event (AmazonGlacier Struct)

Fires once for each part when calling ListParts.

Syntax

// AmazonGlacierPartListEventArgs carries the AmazonGlacier PartList event's parameters.
pub struct AmazonGlacierPartListEventArgs {
  fn archive_description(&self) -> &String
  fn creation_date(&self) -> &String
  fn upload_id(&self) -> &String
  fn start_position(&self) -> i64
  fn size(&self) -> i64
  fn sha256_tree_hash(&self) -> &String
  fn vault_arn(&self) -> &String
}

// AmazonGlacierPartListEvent defines the signature of the AmazonGlacier PartList event's handler function.
pub trait AmazonGlacierPartListEvent {
  fn on_part_list(&self, sender : AmazonGlacier, e : &mut AmazonGlacierPartListEventArgs);
}

impl <'a> AmazonGlacier<'a> {
  pub fn on_part_list(&self) -> &'a dyn AmazonGlacierPartListEvent;
  pub fn set_on_part_list(&mut self, value : &'a dyn AmazonGlacierPartListEvent);
  ...
}

Remarks

This event fires once for each part when calling list_parts.

ArchiveDescription is the description of the archive (if any).

CreationDate is the UTC time that the multipart upload was started. This is a string representation of ISO 8601 date format. For example: "2012-03-20T17:03:43.221Z".

UploadId is the Id of the multipart upload associated with this part.

StartPosition is the byte offset in the archive of the current part.

Size is the part size in bytes.

SHA256TreeHash is the SHA256 tree hash value that Amazon calculated for the part.

VaultArn is the Amazon Resource Name (ARN) of the Vault in which the archive is created.

on_progress event (AmazonGlacier Struct)

Fires during an upload or download to indicate transfer progress.

Syntax

// AmazonGlacierProgressEventArgs carries the AmazonGlacier Progress event's parameters.
pub struct AmazonGlacierProgressEventArgs {
  fn direction(&self) -> i32
  fn bytes_transferred(&self) -> i64
  fn total_bytes(&self) -> i64
  fn percent_done(&self) -> i32
}

// AmazonGlacierProgressEvent defines the signature of the AmazonGlacier Progress event's handler function.
pub trait AmazonGlacierProgressEvent {
  fn on_progress(&self, sender : AmazonGlacier, e : &mut AmazonGlacierProgressEventArgs);
}

impl <'a> AmazonGlacier<'a> {
  pub fn on_progress(&self) -> &'a dyn AmazonGlacierProgressEvent;
  pub fn set_on_progress(&mut self, value : &'a dyn AmazonGlacierProgressEvent);
  ...
}

Remarks

This event fires during an upload or download to indicate the progress of the transfer of the entire request. By default, this event will fire each time PercentDone increases by one percent; the ProgressStep configuration setting can be used to alter this behavior.

Direction indicates whether the transfer is an upload (0) or a download (1).

BytesTransferred reflects the number of bytes that have been transferred so far, or 0 if the transfer is starting (however, see note below).

TotalBytes reflects the total number of bytes that are to be transferred, or -1 if the total is unknown. This amount includes the size of everything in the request like HTTP headers.

PercentDone reflects the overall progress of the transfer, or -1 if the progress cannot be calculated.

NOTE: By default, the struct tracks transfer progress absolutely. If a transfer is interrupted and later resumed, the values reported by this event upon and after resumption will account for the data that was transferred before the interruption.

For example, if 10MB of data was successfully transferred before the interruption, then this event will fire with a BytesTransferred value of 10485760 (10MB) when the transfer is first resumed, and then continue to fire with successively greater values as usual.

This behavior can be changed by disabling the ProgressAbsolute configuration setting, in which case the struct will treat resumed transfers as "new" transfers. In this case, the BytesTransferred parameter will always be 0 the first time this event fires, regardless of whether the transfer is new or being resumed.

on_ssl_server_authentication event (AmazonGlacier Struct)

Fired after the server presents its certificate to the client.

Syntax

// AmazonGlacierSSLServerAuthenticationEventArgs carries the AmazonGlacier SSLServerAuthentication event's parameters.
pub struct AmazonGlacierSSLServerAuthenticationEventArgs {
  fn cert_encoded(&self) -> &[u8]
  fn cert_subject(&self) -> &String
  fn cert_issuer(&self) -> &String
  fn status(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// AmazonGlacierSSLServerAuthenticationEvent defines the signature of the AmazonGlacier SSLServerAuthentication event's handler function.
pub trait AmazonGlacierSSLServerAuthenticationEvent {
  fn on_ssl_server_authentication(&self, sender : AmazonGlacier, e : &mut AmazonGlacierSSLServerAuthenticationEventArgs);
}

impl <'a> AmazonGlacier<'a> {
  pub fn on_ssl_server_authentication(&self) -> &'a dyn AmazonGlacierSSLServerAuthenticationEvent;
  pub fn set_on_ssl_server_authentication(&mut self, value : &'a dyn AmazonGlacierSSLServerAuthenticationEvent);
  ...
}

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

on_ssl_status event (AmazonGlacier Struct)

Fired when secure connection progress messages are available.

Syntax

// AmazonGlacierSSLStatusEventArgs carries the AmazonGlacier SSLStatus event's parameters.
pub struct AmazonGlacierSSLStatusEventArgs {
  fn message(&self) -> &String
}

// AmazonGlacierSSLStatusEvent defines the signature of the AmazonGlacier SSLStatus event's handler function.
pub trait AmazonGlacierSSLStatusEvent {
  fn on_ssl_status(&self, sender : AmazonGlacier, e : &mut AmazonGlacierSSLStatusEventArgs);
}

impl <'a> AmazonGlacier<'a> {
  pub fn on_ssl_status(&self) -> &'a dyn AmazonGlacierSSLStatusEvent;
  pub fn set_on_ssl_status(&mut self, value : &'a dyn AmazonGlacierSSLStatusEvent);
  ...
}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

on_start_transfer event (AmazonGlacier Struct)

This event fires when a document starts transferring (after the headers).

Syntax

// AmazonGlacierStartTransferEventArgs carries the AmazonGlacier StartTransfer event's parameters.
pub struct AmazonGlacierStartTransferEventArgs {
  fn direction(&self) -> i32
}

// AmazonGlacierStartTransferEvent defines the signature of the AmazonGlacier StartTransfer event's handler function.
pub trait AmazonGlacierStartTransferEvent {
  fn on_start_transfer(&self, sender : AmazonGlacier, e : &mut AmazonGlacierStartTransferEventArgs);
}

impl <'a> AmazonGlacier<'a> {
  pub fn on_start_transfer(&self) -> &'a dyn AmazonGlacierStartTransferEvent;
  pub fn set_on_start_transfer(&mut self, value : &'a dyn AmazonGlacierStartTransferEvent);
  ...
}

Remarks

The on_start_transfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

on_transfer event (AmazonGlacier Struct)

Fired while a document transfers (delivers document).

Syntax

// AmazonGlacierTransferEventArgs carries the AmazonGlacier Transfer event's parameters.
pub struct AmazonGlacierTransferEventArgs {
  fn direction(&self) -> i32
  fn bytes_transferred(&self) -> i64
  fn percent_done(&self) -> i32
  fn text(&self) -> &[u8]
}

// AmazonGlacierTransferEvent defines the signature of the AmazonGlacier Transfer event's handler function.
pub trait AmazonGlacierTransferEvent {
  fn on_transfer(&self, sender : AmazonGlacier, e : &mut AmazonGlacierTransferEventArgs);
}

impl <'a> AmazonGlacier<'a> {
  pub fn on_transfer(&self) -> &'a dyn AmazonGlacierTransferEvent;
  pub fn set_on_transfer(&mut self, value : &'a dyn AmazonGlacierTransferEvent);
  ...
}

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

NOTE: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

on_vault_list event (AmazonGlacier Struct)

Fires once for each vault returned when calling ListVaults.

Syntax

// AmazonGlacierVaultListEventArgs carries the AmazonGlacier VaultList event's parameters.
pub struct AmazonGlacierVaultListEventArgs {
  fn creation_date(&self) -> &String
  fn last_inventory_date(&self) -> &String
  fn vault_arn(&self) -> &String
  fn vault_name(&self) -> &String
  fn archive_count(&self) -> i32
  fn size(&self) -> i64
}

// AmazonGlacierVaultListEvent defines the signature of the AmazonGlacier VaultList event's handler function.
pub trait AmazonGlacierVaultListEvent {
  fn on_vault_list(&self, sender : AmazonGlacier, e : &mut AmazonGlacierVaultListEventArgs);
}

impl <'a> AmazonGlacier<'a> {
  pub fn on_vault_list(&self) -> &'a dyn AmazonGlacierVaultListEvent;
  pub fn set_on_vault_list(&mut self, value : &'a dyn AmazonGlacierVaultListEvent);
  ...
}

Remarks

This event fires once for each vault returned when calling list_vaults.

CreationDate is the date the vault was created, in Coordinated Universal Time (UTC). This is a string representation of ISO 8601 date format, for example: 2012-03-20T17:03:43.221Z.

LastInventoryDate is the date of the last vault inventory, in Coordinated Universal Time (UTC). This is a string representation of ISO 8601 date format, for example: 2012-03-20T17:03:43.221Z.

VaultArn is the Amazon Resource Name (ARN) of the vault.

VaultName is the name of the vault.

ArchiveCount is the number of archives in the vault as of LastInventoryDate.

Size is the size of all the archives (including any per-archive overhead) in the vault, as of the last inventory date.

Config Settings (AmazonGlacier Struct)

AmazonGlacier Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (AmazonGlacier Struct)

Common Errors

The class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors