Interface: credentials.Provider

import "../ibm-cos-sdk-go/aws/credentials"

Overview

A Provider is the interface for any component which will provide credentials Value. A provider is required to manage its own Expired state, and what to be expired means.

The Provider should not need to implement its own mutexes, because that will be managed by Credentials.

Implemented By

credentials.ChainProvider, credentials.EnvProvider, credentials.ErrorProvider, processcreds.ProcessProvider, ibmiam.Provider, plugincreds.Provider, endpointcreds.Provider, credentials.SharedCredentialsProvider, credentials.StaticProvider, ibmiam.TrustedProfileProvider

Interface Method Summary

• IsExpired() bool interface

  IsExpired returns if the credentials are no longer valid, and need to be retrieved.

• Retrieve() (Value, error) interface

  Retrieve returns nil if it successfully retrieved the value.

Interface Method Details

IsExpired() bool

This method is abstract.

IsExpired returns if the credentials are no longer valid, and need to be retrieved.

// File 'aws/credentials/credentials.go', line 119

IsExpired() bool

Retrieve() (Value, error)

This method is abstract.

Retrieve returns nil if it successfully retrieved the value. Error is returned if the value were not obtainable, or empty.

// File 'aws/credentials/credentials.go', line 115

Retrieve() (Value, error)