README.md

Go client for Salesforce Bulkv2 API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: 56.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen

Documentation for API Endpoints

All URIs are relative to https://test.salesforce.com/services/data/v56.0

Class	Method	HTTP request	Summary
JobApi	CloseOrAbortJob	Patch /jobs/ingest/{jobId}	Close or Abort a Job
JobApi	CreateJob	Post /jobs/ingest	Create a job
JobApi	DeleteJob	Delete /jobs/ingest/{jobId}	Delete a Job
JobApi	GetJobFailedResults	Get /jobs/ingest/{jobId}/failedResults	Get Job Failed Record Results
JobApi	GetJobInfo	Get /jobs/ingest/{jobId}	Get Job Info
JobApi	GetJobSuccessfulResults	Get /jobs/ingest/{jobId}/successfulResults	Get Job Successful Record Results
JobApi	GetJobUnprocessedRecords	Get /jobs/ingest/{jobId}/unprocessedrecords	Get Job Unprocessed Record Results
JobApi	GetJobs	Get /jobs/ingest	Get All Jobs
JobApi	UploadJobData	Put /jobs/ingest/{jobId}/batches	Upload Job Data
QueryApi	AbortQueryJob	Patch /jobs/query/{jobId}	Abort a Query Job
QueryApi	CreateQueryJob	Post /jobs/query	Create a Query Job
QueryApi	DeleteQueryJob	Delete /jobs/query/{jobId}	Delete a Query Job
QueryApi	GetQueryJobInfo	Get /jobs/query/{jobId}	Get Information About a Query Job
QueryApi	GetQueryJobResults	Get /jobs/query/{jobId}/results	Get Results for a Query Job
QueryApi	GetQueryJobs	Get /jobs/query	Get Information About All Query Jobs

Documentation For Models

• AbortQueryJobRequest
• CloseOrAbortJobRequest
• ColumnDelimiter
• ContentType
• CreateJobRequest
• CreateQueryJobRequest
• EncodingType
• Job
• JobCloseAbortState
• JobInfo
• JobInfoExt
• JobOperation
• JobState
• JobType
• Jobs
• LineEnding
• QueryAbortState
• QueryJob
• QueryJobCreateRequestExt
• QueryJobInfo
• QueryJobInfoExt
• QueryJobInfos
• QueryJobState
• QueryJobType
• QueryOperation

Documentation For Authorization

oAuth (password)

• Type: OAuth
• Flow: password
• Authorization URL:
• Scopes: N/A

Example

package main

import (
    "golang.org/x/oauth2"
    "context"
)

func main() {
    oAuth2Cfg := oauth2.Config{}
    token, err := oAuth2Cfg.PasswordCredentialsToken(context.Background(), "username", "password")
    if err != nil {
        panic(err)
    }
    tokenSrc := oAuth2Cfg.TokenSource(context.Background(), token)
    packageName.NewAPIClient(packageName.NewConfiguration(), tokenSrc)
}

oAuth (application)

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes: N/A

Example

package main

import (
    "golang.org/x/oauth2"
    "context"
)

func main() {
    oAuth2Cfg := clientcredentials.Config{}
    tokenSrc := oAuth2Cfg.TokenSource(context.Background())
    packageName.NewAPIClient(packageName.NewConfiguration(), tokenSrc)
}

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author

russell-laboe@outlook.com