package
2.1.1+incompatible
Repository: https://github.com/ibm/go-sdk-core.git
Documentation: pkg.go.dev
# Functions
BoolPtr returns a pointer to boolean literal.
Float32Ptr returns a pointer to float32 literal.
Float64Ptr returns a pointer to float64 literal.
GetAuthenticatorFromEnvironment instantiates an Authenticator using service properties retrieved from external config sources.
GetCurrentTime returns the current Unix time.
HasBadFirstOrLastChar checks if the string starts with `{` or `"` or ends with `}` or `"`.
Int64Ptr returns a pointer to int64 literal.
IsJSONMimeType Returns true iff the specified mimeType value represents a "JSON" mimetype.
IsJSONPatchMimeType returns true iff the specified mimeType value represents a "JSON Patch" mimetype.
NewBaseService constructs a new instance of BaseService.
NewBasicAuthenticator constructs a new BasicAuthenticator instance.
NewBearerTokenAuthenticator constructs a new BearerTokenAuthenticator instance.
NewCloudPakForDataAuthenticator constructs a new CloudPakForDataAuthenticator instance.
NewIamAuthenticator constructs a new IamAuthenticator instance.
No description provided by the author
NewRequestBuilder initiates a new request.
PrettyPrint print pretty.
StringNilMapper de-references the parameter 's' and returns the result, or "" if 's' is nil.
StringPtr returns a pointer to string literal.
SystemInfo returns the system information.
UserHomeDir returns the user home directory.
ValidateNotNil returns the specified error if 'object' is nil, nil otherwise.
ValidateStruct validates 'param' (assumed to be a struct) according to the annotations attached to its fields.
# Constants
common headers.
common headers.
Supported authentication types.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
common headers.
common headers.
IamAuthenticator-related constants.
DEFAULT_CREDENTIAL_FILE_NAME is the default filename for a credentials file.
IamAuthenticator-related constants.
common HTTP methods.
No description provided by the author
No description provided by the author
No description provided by the author
Common error messages.
No description provided by the author
common headers.
common headers.
No description provided by the author
common headers.
common HTTP methods.
common HTTP methods.
IBM_CREDENTIAL_FILE_ENVVAR is the environment key used to find the path to a credentials file.
common HTTP methods.
common HTTP methods.
Constants for CP4D.
No description provided by the author
No description provided by the author
Authenticator properties.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Service client properties.
No description provided by the author
common HTTP methods.
IamAuthenticator-related constants.
IamAuthenticator-related constants.
SSL error.
# Variables
Validate is a shared validator instance used to perform validation of structs.
# Structs
BaseService implements the common functionality shared by generated services to manage requests and responses, authenticate outbound requests, etc.
BasicAuthenticator takes a user-supplied username and password, and adds them to requests via an Authorization header of the form:
Authorization: Basic <encoded username and password>
.
BearerTokenAuthenticator will take a user-supplied bearer token and adds it to requests via an Authorization header of the form:
Authorization: Bearer <bearer-token>
.
CloudPakForDataAuthenticator uses a username and password pair to obtain a suitable bearer token, and adds the bearer token to requests via an Authorization header of the form:
Authorization: Bearer <bearer-token>
.
DetailedResponse holds the response information received from the server.
Error is a struct used to represent a single error received in an operation response.
Errors is a struct used to hold an array of errors received in an operation response.
FormData stores information for form data.
IamAuthenticator uses an apikey to obtain a suitable bearer token value, and adds the bearer token to requests via an Authorization header of the form:
Authorization: Bearer <bearer-token>
.
NoAuthAuthenticator is simply a placeholder implementation of the Authenticator interface that performs no authentication.
RequestBuilder is used to build an HTTP Request instance.
ServiceOptions is a struct of configuration values for a service.
# Interfaces
Authenticator describes the set of methods implemented by each authenticator.