Loading...
Searching...
No Matches
SalesforceRestClient Namespace Reference

the SalesforceRestClient namespace contains all the objects in the SalesforceRestClient module More...

## Classes

class | SalesforceRestClient
| this class provides the REST client API for communication with Salesforce.com More...
class | SalesforceRestConnection
| class for Salesforce.com REST connections; returns SalesforceRestClient::SalesforceRestClient objects More...
class | SalesforceRestPingPollOperation
| REST ping polling I/O class with OAuth2 authentication. More...

## Variables

const | BulkJobContentTypes
| a hash of Salesforce.com bulk job content types; keys are Salesforce.com Bulk REST API Job Content Types; values are Mime `Content-Type` strings
const | BulkJobCsv = "CSV"
const | BulkJobDelete = "delete"
| Salesforce.com bulk job "delete" operation.
const | BulkJobInsert = "insert"
| Salesforce.com bulk job "insert" operation.
const | BulkJobJson = "JSON"
| Salesforce.com bulk job "JSON" content type.
const | BulkJobOperations
| a hash of Salesforce.com bulk job operations; keys are Salesforce.com Bulk REST API Job Operations
const | BulkJobQuery = "query"
const | BulkJobUpdate = "update"
| Salesforce.com bulk job "update" operation.
const | BulkJobUpsert = "upsert"
| Salesforce.com bulk job "upsert" operation.
const | BulkJobXml = "XML"
| Salesforce.com bulk job "XML" content type.
const | BulkJobZipCsv = "ZIP_CSV"
| Salesforce.com bulk job "ZIP_CSV" content type.
const | BulkJobZipJson = "ZIP_JSON"
| Salesforce.com bulk job "ZIP_JSON" content type.
const | BulkJobZipXml = "ZIP_XML"
| Salesforce.com bulk job "ZIP_XML" content type.

## Detailed Description

the SalesforceRestClient namespace contains all the objects in the SalesforceRestClient module

## Variable Documentation

## BulkJobContentTypes

const SalesforceRestClient::BulkJobContentTypes

Initial value:
= {
BulkJobCsv: MimeTypeCsv,
BulkJobJson: MimeTypeJson,
BulkJobXml: MimeTypeXmlApp,
BulkJobZipCsv: "zip/csv",
BulkJobZipJson: "zip/json",
BulkJobZipXml: "zip/xml",
}
SalesforceRestClient::BulkJobZipCsv
const BulkJobZipCsv
Salesforce.com bulk job "ZIP_CSV" content type.
Definition: SalesforceRestClient.qm:227
SalesforceRestClient::BulkJobCsv
const BulkJobCsv
Definition: SalesforceRestClient.qm:218
SalesforceRestClient::BulkJobXml
const BulkJobXml
Salesforce.com bulk job "XML" content type.
Definition: SalesforceRestClient.qm:224
SalesforceRestClient::BulkJobJson
const BulkJobJson
Salesforce.com bulk job "JSON" content type.
Definition: SalesforceRestClient.qm:221
SalesforceRestClient::BulkJobZipJson
const BulkJobZipJson
Salesforce.com bulk job "ZIP_JSON" content type.
Definition: SalesforceRestClient.qm:230
SalesforceRestClient::BulkJobZipXml
const BulkJobZipXml
Salesforce.com bulk job "ZIP_XML" content type.
Definition: SalesforceRestClient.qm:233

a hash of Salesforce.com bulk job content types; keys are Salesforce.com Bulk REST API Job Content Types; values are Mime `Content-Type` strings

valid content types are:

- `BulkJobCsv` (`"CSV"`)
- `BulkJobJson` (`"JSON"`)
- `BulkJobXml` (`"XML"`)
- `BulkJobZipCsv` (`"ZIP_CSV"`)
- `BulkJobZipJson` (`"ZIP_JSON"`)
- `BulkJobZipXml` (`"ZIP_XML"`)

## BulkJobOperations

const SalesforceRestClient::BulkJobOperations

Initial value:
= {
BulkJobQuery: True,
BulkJobInsert: True,
BulkJobUpdate: True,
BulkJobUpsert: True,
BulkJobDelete: True,
}
SalesforceRestClient::BulkJobQuery
const BulkJobQuery
Definition: SalesforceRestClient.qm:183
SalesforceRestClient::BulkJobUpsert
const BulkJobUpsert
Salesforce.com bulk job "upsert" operation.
Definition: SalesforceRestClient.qm:192
SalesforceRestClient::BulkJobDelete
const BulkJobDelete
Salesforce.com bulk job "delete" operation.
Definition: SalesforceRestClient.qm:195
SalesforceRestClient::BulkJobInsert
const BulkJobInsert
Salesforce.com bulk job "insert" operation.
Definition: SalesforceRestClient.qm:186
SalesforceRestClient::BulkJobUpdate
const BulkJobUpdate
Salesforce.com bulk job "update" operation.
Definition: SalesforceRestClient.qm:189

a hash of Salesforce.com bulk job operations; keys are Salesforce.com Bulk REST API Job Operations

valid operations are:

- BulkJobQuery (`"query"`)
- BulkJobInsert (`"insert"`)
- BulkJobUpdate (`"update"`)
- BulkJobUpsert (`"upsert"`)
- BulkJobDelete (`"delete"`)