Documentation
¶
Index ¶
- type Client
- type Options
- type References
- func (r *References) AddReferenceToNetwork(ctx context.Context, networkID string, resource client.Object) error
- func (r *References) AddReferenceToNetworkID(ctx context.Context, networkID regionids.NetworkID, resource client.Object) error
- func (r *References) RemoveReferenceFromNetwork(ctx context.Context, networkID string, resource client.Object) error
- func (r *References) RemoveReferenceFromNetworkID(ctx context.Context, networkID regionids.NetworkID, resource client.Object) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client wraps up the raw OpenAPI client with things to make it useable e.g. authorization and TLS.
func New ¶
func New(client client.Client, options *Options, clientOptions *coreclient.HTTPClientOptions) *Client
New creates a new client.
func (*Client) APIClient ¶ added in v1.4.0
APIClient returns a new OpenAPI client that can be used to access the Region API from another service provider's API.
func (*Client) ControllerClient ¶ added in v1.4.0
func (c *Client) ControllerClient(ctx context.Context, resource metav1.Object) (*openapi.ClientWithResponses, error)
ControllerClient returns a new OpenAPI client that can be used to access the Region API from another service provider's controller. It requires a custom resource, owned by that service provider, that persists identity principal information.
type Options ¶ added in v0.1.7
type Options = coreclient.HTTPOptions
func NewOptions ¶ added in v0.1.33
func NewOptions() *Options
NewOptions must be used to create options for consistency.
type References ¶ added in v1.16.0
type References struct {
// contains filtered or unexported fields
}
References allows references to be added and removed on identity resources from remote services.
func NewReferences ¶ added in v1.16.0
func NewReferences(serviceDescriptor util.ServiceDescriptor, serverOptions *coreclient.HTTPOptions, clientOptions *coreclient.HTTPClientOptions) *References
func (*References) AddReferenceToNetwork ¶ added in v1.16.0
func (r *References) AddReferenceToNetwork(ctx context.Context, networkID string, resource client.Object) error
AddReferenceToNetwork is the backwards-compatible string variant of AddReferenceToNetworkID, retained for callers that hold an untyped network ID. Prefer AddReferenceToNetworkID where a typed ID is already in hand.
func (*References) AddReferenceToNetworkID ¶ added in v1.17.4
func (*References) RemoveReferenceFromNetwork ¶ added in v1.16.0
func (r *References) RemoveReferenceFromNetwork(ctx context.Context, networkID string, resource client.Object) error
RemoveReferenceFromNetwork is the backwards-compatible string variant of RemoveReferenceFromNetworkID, retained for callers that hold an untyped network ID. Prefer RemoveReferenceFromNetworkID where a typed ID is already in hand.