package
4.10.0
Repository: https://github.com/ibm/go-sdk-core.git
Documentation: pkg.go.dev

# Functions

BoolPtr returns a pointer to boolean literal.
ConvertSlice Marshals 'slice' to a json string, performs string manipulation on the resulting string, and converts the string to a '[]string'.
CopyMap returns a shallow copy of the specified map.
DefaultHTTPClient returns a non-retryable http client with default configuration.
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.
GetLogger returns the Logger instance currently used by the Go core.
GetServiceProperties returns a map containing configuration properties for the specified service that are retrieved from external configuration sources in the following precedence order: 1) credential file 2) environment variables 3) VCAP_SERVICES 'serviceName' is used as a filter against the property names.
HasBadFirstOrLastChar checks if the string starts with `{` or `"` or ends with `}` or `"`.
IBMCloudSDKBackoffPolicy provides a default implementation of the Backoff interface associated with a retryablehttp.Client.
IBMCloudSDKRetryPolicy provides a default implementation of the CheckRetry interface associated with a retryablehttp.Client.
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.
IsNil checks if the specified object is nil or not.
No description provided by the author
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 from a username/password pair.
NewCloudPakForDataAuthenticatorUsingAPIKey constructs a new CloudPakForDataAuthenticator instance from a username/apikey pair.
NewCloudPakForDataAuthenticatorUsingPassword constructs a new CloudPakForDataAuthenticator instance from a username/password pair.
NewGzipCompressionReader will return an io.Reader instance that will deliver the gzip-compressed version of the "uncompressedReader" argument.
NewGzipDecompressionReader will return an io.Reader instance that will deliver the gzip-decompressed version of the "compressedReader" argument.
NewIamAuthenticator constructs a new IamAuthenticator instance.
NewLogger constructs an SDKLoggerImpl instance with the specified logging level enabled and the specified log.Logger instance as the underlying logger to use.
No description provided by the author
NewRequestBuilder initiates a new request.
NewRetryableHTTPClient returns a new instance of go-retryablehttp.Client with a default configuration that supports Go SDK usage.
NormalizeDateTimeUTC normalizes t to reflect UTC timezone for marshaling.
PrettyPrint print pretty.
SetLogger sets the specified Logger instance as the logger to be used by the Go core library.
SetLoggingLevel will enable the specified logging level in the Go core library.
SliceContains returns true iff "contains" is an element of "slice".
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.
UnmarshalAny retrieves the specified property from the map and returns it as a generic value (i.e.
UnmarshalAnyMap retrieves the specified property from the map "m" and returns it as a map[string]interface{}, or nil if the property wasn't found in the map.
UnmarshalAnyMapSlice retrieves the specified property from the map "m" and returns it as a []map[string]interface{}, or nil if the property wasn't found in the map.
UnmarshalAnySlice retrieves the specified property from the map and returns it as a slice of generic values (i.e.
UnmarshalBool retrieves the specified property from the map and returns it as a bool or nil if the property wasn't found in the map.
UnmarshalBoolMap retrieves the specified property from the map "m" and returns it as a map[string]bool, or nil if the property wasn't found in the map.
UnmarshalBoolMapSlice retrieves the specified property from the map "m" and returns it as a []map[string]bool, or nil if the property wasn't found in the map.
UnmarshalBoolSlice retrieves the specified property from the map and returns it as a bool slice or nil if the property wasn't found in the map.
UnmarshalByteArray retrieves the specified property from the map and returns it as a byte array or nil if the property wasn't found in the map.
UnmarshalByteArrayMap retrieves the specified property from the map "m" and returns it as a map[string][]byte, or nil if the property wasn't found in the map.
UnmarshalByteArrayMapSlice retrieves the specified property from the map "m" and returns it as a []map[string][]byte, or nil if the property wasn't found in the map.
UnmarshalByteArraySlice retrieves the specified property from the map and returns it as a byte array slice or nil if the property wasn't found in the map.
UnmarshalDate retrieves the specified property from the map and returns it as a Date or nil if the property wasn't found in the map.
UnmarshalDateMap retrieves the specified property from the map "m" and returns it as a map[string]strfmt.Date, or nil if the property wasn't found in the map.
UnmarshalDateMapSlice retrieves the specified property from the map "m" and returns it as a []map[string]strfmt.Date, or nil if the property wasn't found in the map.
UnmarshalDateSlice retrieves the specified property from the map and returns it as a Date slice or nil if the property wasn't found in the map.
UnmarshalDateTime retrieves the specified property from the map and returns it as a DateTime or nil if the property wasn't found in the map.
UnmarshalDateTimeMap retrieves the specified property from the map "m" and returns it as a map[string]strfmt.DateTime, or nil if the property wasn't found in the map.
UnmarshalDateTimeMapSlice retrieves the specified property from the map "m" and returns it as a []map[string]strfmt.DateTime, or nil if the property wasn't found in the map.
UnmarshalDateTimeSlice retrieves the specified property from the map and returns it as a DateTime slice or nil if the property wasn't found in the map.
UnmarshalFloat32 retrieves the specified property from the map and returns it as a float32 or nil if the property wasn't found in the map.
UnmarshalFloat32Map retrieves the specified property from the map "m" and returns it as a map[string]float32, or nil if the property wasn't found in the map.
UnmarshalFloat32MapSlice retrieves the specified property from the map "m" and returns it as a []map[string]float32, or nil if the property wasn't found in the map.
UnmarshalFloat32Slice retrieves the specified property from the map and returns it as a float32 slice or nil if the property wasn't found in the map.
UnmarshalFloat64 retrieves the specified property from the map and returns it as a float64 or nil if the property wasn't found in the map.
UnmarshalFloat64Map retrieves the specified property from the map "m" and returns it as a map[string]float64, or nil if the property wasn't found in the map.
UnmarshalFloat64MapSlice retrieves the specified property from the map "m" and returns it as a []map[string]float64, or nil if the property wasn't found in the map.
UnmarshalFloat64Slice retrieves the specified property from the map and returns it as a float64 slice or nil if the property wasn't found in the map.
UnmarshalInt64 retrieves the specified property from the map and returns it as an int64 or nil if the property wasn't found in the map.
UnmarshalInt64Map retrieves the specified property from the map "m" and returns it as a map[string]int64, or nil if the property wasn't found in the map.
UnmarshalInt64MapSlice retrieves the specified property from the map "m" and returns it as a []map[string]int64, or nil if the property wasn't found in the map.
UnmarshalInt64Slice retrieves the specified property from the map and returns it as an int64 slice or nil if the property wasn't found in the map.
UnmarshalModel unmarshals 'rawInput' into 'result' while using 'unmarshaller' to unmarshal model instances.
UnmarshalObject retrieves the specified property from the map and returns it as a generic object (i.e.
UnmarshalObjectSlice retrieves the specified property from the map and returns it as a slice of generic objects (i.e.
UnmarshalPrimitive retrieves the specified property from 'rawInput', then unmarshals the resulting value into 'result'.
UnmarshalString retrieves the specified property from the map and returns it as a string or nil if the property wasn't found in the map.
UnmarshalStringMap retrieves the specified property from the map "m" and returns it as a map[string]string, or nil if the property wasn't found in the map.
UnmarshalStringMapSlice retrieves the specified property from the map "m" and returns it as a []map[string]string, or nil if the property wasn't found in the map.
UnmarshalStringSlice retrieves the specified property from the map and returns it as a string slice or nil if the property wasn't found in the map.
UnmarshalUUID retrieves the specified property from the map and returns it as a UUID or nil if the property wasn't found in the map.
UnmarshalUUIDMap retrieves the specified property from the map "m" and returns it as a map[string]strfmt.UUID, or nil if the property wasn't found in the map.
UnmarshalUUIDMapSlice retrieves the specified property from the map "m" and returns it as a []map[string]strfmt.UUID, or nil if the property wasn't found in the map.
UnmarshalUUIDSlice retrieves the specified property from the map and returns it as a UUID slice or nil if the property wasn't found in the map.
UserHomeDir returns the user home directory.
ValidateNotNil returns the specified error if 'object' is nil, nil otherwise.
ValidateStruct validates 'param' (assumed to be a ptr to 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.
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
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
common headers.
No description provided by the author
Common error messages.
No description provided by the author
No description provided by the author
common headers.
common headers.
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 HTTP methods.
common HTTP methods.
IBM_CREDENTIAL_FILE_ENVVAR is the environment key used to find the path to a credentials file.
Log level constants.
Log level constants.
Log level constants.
Log level constants.
Log level constants.
common HTTP methods.
POST
common HTTP methods.
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
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.
#nosec G101 */.
IamAuthenticator-related constants.
SSL error.

# Variables

Validate is a shared validator instance used to perform validation of structs.

# Structs

AuthenticationError describes the error returned when authentication fails.
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 either a username/password pair or a username/apikey pair to obtain a suitable bearer token from the CP4D authentication service, 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> .
IamTokenServerResponse : This struct models a response received from the token server.
NoAuthAuthenticator is simply a placeholder implementation of the Authenticator interface that performs no authentication.
RequestBuilder is used to build an HTTP Request instance.
SDKLoggerImpl is the Go core's implementation of the Logger interface.
ServiceOptions is a struct of configuration values for a service.

# Interfaces

Authenticator describes the set of methods implemented by each authenticator.
Logger is the logging interface implemented and used by the Go core library.

# Type aliases

LogLevel defines a type for logging levels.
ModelUnmarshaller defines the interface for a generated Unmarshal<model>() function, which is used by the various "UnmarshalModel" functions below to unmarshal an instance of the user-defined model type.