BoolPtr returns a pointer to boolean literal.

ByteArrayPtr returns a pointer to []byte literal.

ConstructServiceURL returns a service URL that is constructed by formatting a parameterized URL.

ConvertSlice marshals 'slice' to a json string, performs string manipulation on the resulting string, and converts the string to a '[]string'.

CreateIDHash computes a unique ID based on a given prefix and problem attribute fields.

DefaultHTTPClient returns a non-retryable http client with default configuration.

EnrichHTTPProblem takes an problem and, if it originated as an HTTPProblem, populates the fields of the underlying HTTP problem with the given service/operation information.

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.

GetQueryParam returns a pointer to the value of query parameter `param` from urlStr, or nil if not found.

GetQueryParamAsInt returns a pointer to the value of query parameter `param` from urlStr converted to an int64 value, or nil if not found.

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.

IBMErrorf creates and returns a new instance of an IBMProblem struct with "error" level severity.

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.

NewAuthenticationError is a deprecated function that was previously used for creating new AuthenticationError structs.

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.

NewContainerAuthenticatorBuilder returns a new builder struct that can be used to construct a ContainerAuthenticator instance.

NewFileWithMetadata : Instantiate FileWithMetadata (Generic Model Constructor).

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.

NewIamAssumeAuthenticatorBuilder returns a new builder struct that can be used to construct an IamAssumeAuthenticator instance.

NewIamAuthenticator constructs a new IamAuthenticator instance.

NewIamAuthenticatorBuilder returns a new builder struct that can be used to construct an IamAuthenticator instance.

NewLogger constructs an SDKLoggerImpl instance with the specified logging level enabled.

NewMCSPAuthenticatorBuilder returns a new builder struct that can be used to construct an MCSPAuthenticator instance.

NewOrderedMaps initializes and returns a new instance of OrderedMaps.

NewRequestBuilder initiates a new request.

NewRetryableClientWithHTTPClient will return a new instance of a retryable client, using "httpClient" as the embedded client used to invoke individual requests within the retry logic.

NewRetryableHTTPClient returns a new instance of a retryable client with a default configuration that supports Go SDK usage.

NewVpcInstanceAuthenticatorBuilder returns a new builder struct that can be used to construct a VpcInstanceAuthenticator instance.

NormalizeDateTimeUTC normalizes t to reflect UTC timezone for marshaling.

ParseDate parses the specified RFC3339 full-date string (YYYY-MM-DD) and returns a strfmt.Date instance.

ParseDateTime parses the specified date-time string and returns a strfmt.DateTime instance.

PrettyPrint print pretty.

RedactSecrets() returns the input string with secrets redacted.

RepurposeSDKProblem provides a convenient way to take a problem from another function in the same component and contextualize it to the current function.

SDKErrorf creates and returns a new instance of "SDKProblem" with "error" level severity.

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.

UnmarshalFileWithMetadata unmarshals an instance of FileWithMetadata from the specified map of raw messages.

UnmarshalModel unmarshals 'rawInput' into 'result' while using 'unmarshaller' to unmarshal model instances.

UnmarshalPrimitive retrieves the specified property from 'rawInput', then unmarshals the resulting value into 'result'.

UserHomeDir returns the user home directory.

UUIDPtr returns a pointer to strfmt.UUID literal.

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.

common headers.

common headers.

Supported authentication types.

common headers.

common headers.

common headers.

DEFAULT_CREDENTIAL_FILE_NAME is the default filename for a credentials file.

common HTTP methods.

#nosec G101.

common headers.

Common error messages.

common headers.

common headers.

#nosec G101.

#nosec G101.

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.

The name of this module - matches the value in the go.mod file.

common HTTP methods.

common HTTP methods.

Authenticator properties.

#nosec G101.

#nosec G101.

Service client properties.

common HTTP methods.

SSL error.

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

AuthenticationError describes the problem returned when authentication over HTTP 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>.

ContainerAuthenticator implements an IAM-based authentication schema whereby it retrieves a "compute resource token" from the local compute resource (VM) and uses that to obtain an IAM access token by invoking the IAM "get token" operation with grant-type=cr-token.

ContainerAuthenticatorBuilder is used to construct an instance of the ContainerAuthenticator.

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.

FileWithMetadata : A file with its associated metadata.

FormData stores information for form data.

HTTPProblem provides a type suited to problems that occur as the result of an HTTP request.

IamAssumeAuthenticator obtains an IAM access token using the IAM "get-token" operation's "assume" grant type.

IamAssumeAuthenticatorBuilder is used to construct an IamAssumeAuthenticator instance.

IamAuthenticator uses an apikey to obtain an IAM access token, and adds the access token to requests via an Authorization header of the form: Authorization: Bearer <access-token>.

IamAuthenticatorBuilder is used to construct an IamAuthenticator instance.

IamTokenServerResponse : This struct models a response received from the token server.

IBMProblem holds the base set of fields that all problem types should include.

MCSPAuthenticator uses an apikey to obtain an access token, and adds the access token to requests via an Authorization header of the form: "Authorization: Bearer <access-token>".

MCSPAuthenticatorBuilder is used to construct an MCSPAuthenticator instance.

MCSPTokenServerResponse : This struct models a response received from the token server.

NoAuthAuthenticator is simply a placeholder implementation of the Authenticator interface that performs no authentication.

OrderedMaps provides a wrapper around the yaml package's MapItem type and provides convenience functionality beyond what would be available with the MapSlice type, which is similar.

ProblemComponent is a structure that holds information about a given component.

RequestBuilder is used to build an HTTP Request instance.

SDKLoggerImpl is the Go core's implementation of the Logger interface.

SDKProblem provides a type suited to problems that occur in SDK projects.

ServiceOptions is a struct of configuration values for a service.

VpcInstanceAuthenticator implements an authentication scheme in which it retrieves an "instance identity token" and exchanges that for an IAM access token using the VPC Instance Metadata Service API which is available on the local compute resource (VM).

VpcInstanceAuthenticatorBuilder is used to construct an instance of the VpcInstanceAuthenticator.

Authenticator describes the set of methods implemented by each authenticator.

Logger is the logging interface implemented and used by the Go core library.

OrderableProblem provides an interface for retrieving ordered representations of problems in order to print YAML messages with a controlled ordering of the fields.

Problem is an interface that describes the common behavior of custom IBM problem message types.

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.