Documentation ¶
Overview ¶
Package config implement the Configuration Management Client.
Index ¶
- func IsValidName(name string) error
- type Client
- func (c *Client) Close() error
- func (c *Client) CreateApplication(ctx context.Context, request *configpb.CreateApplicationRequest, ...) (*configpb.CreateApplicationResponse, error)
- func (c *Client) CreateApplicationAgent(ctx context.Context, request *configpb.CreateApplicationAgentRequest, ...) (*configpb.CreateApplicationAgentResponse, error)
- func (c *Client) CreateApplicationSpace(ctx context.Context, request *configpb.CreateApplicationSpaceRequest, ...) (*configpb.CreateApplicationSpaceResponse, error)
- func (c *Client) CreateConfigNode(ctx context.Context, request *NodeRequest, opts ...grpc.CallOption) (*configpb.CreateConfigNodeResponse, error)
- func (c *Client) CreateServiceAccount(ctx context.Context, request *configpb.CreateServiceAccountRequest, ...) (*configpb.CreateServiceAccountResponse, error)
- func (c *Client) DeleteApplication(ctx context.Context, request *configpb.DeleteApplicationRequest, ...) (*configpb.DeleteApplicationResponse, error)
- func (c *Client) DeleteApplicationAgent(ctx context.Context, request *configpb.DeleteApplicationAgentRequest, ...) (*configpb.DeleteApplicationAgentResponse, error)
- func (c *Client) DeleteApplicationAgentCredential(ctx context.Context, request *configpb.DeleteApplicationAgentCredentialRequest, ...) (*configpb.DeleteApplicationAgentCredentialResponse, error)
- func (c *Client) DeleteApplicationSpace(ctx context.Context, request *configpb.DeleteApplicationSpaceRequest, ...) (*configpb.DeleteApplicationSpaceResponse, error)
- func (c *Client) DeleteConfigNode(ctx context.Context, req *NodeRequest, opts ...grpc.CallOption) (*configpb.DeleteConfigNodeResponse, error)
- func (c *Client) DeleteServiceAccount(ctx context.Context, request *configpb.DeleteServiceAccountRequest, ...) (*configpb.DeleteServiceAccountResponse, error)
- func (c *Client) DeleteServiceAccountCredential(ctx context.Context, request *configpb.DeleteServiceAccountCredentialRequest, ...) (*configpb.DeleteServiceAccountCredentialResponse, error)
- func (c *Client) ListApplicationAgents(ctx context.Context, request *configpb.ListApplicationAgentsRequest, ...) (configpb.ConfigManagementAPI_ListApplicationAgentsClient, error)
- func (c *Client) ListApplicationSpaces(ctx context.Context, request *configpb.ListApplicationSpacesRequest, ...) (configpb.ConfigManagementAPI_ListApplicationSpacesClient, error)
- func (c *Client) ListApplications(ctx context.Context, request *configpb.ListApplicationsRequest, ...) (configpb.ConfigManagementAPI_ListApplicationsClient, error)
- func (c *Client) ListConfigNodeVersions(ctx context.Context, req *NodeRequest, opts ...grpc.CallOption) (*configpb.ListConfigNodeVersionsResponse, error)
- func (c *Client) ReadApplication(ctx context.Context, request *configpb.ReadApplicationRequest, ...) (*configpb.ReadApplicationResponse, error)
- func (c *Client) ReadApplicationAgent(ctx context.Context, request *configpb.ReadApplicationAgentRequest, ...) (*configpb.ReadApplicationAgentResponse, error)
- func (c *Client) ReadApplicationAgentCredential(ctx context.Context, request *configpb.ReadApplicationAgentCredentialRequest, ...) (*configpb.ReadApplicationAgentCredentialResponse, error)
- func (c *Client) ReadApplicationSpace(ctx context.Context, request *configpb.ReadApplicationSpaceRequest, ...) (*configpb.ReadApplicationSpaceResponse, error)
- func (c *Client) ReadConfigNode(ctx context.Context, req *NodeRequest, opts ...grpc.CallOption) (*configpb.ReadConfigNodeResponse, error)
- func (c *Client) ReadCustomer(ctx context.Context, request *configpb.ReadCustomerRequest, ...) (*configpb.ReadCustomerResponse, error)
- func (c *Client) ReadServiceAccount(ctx context.Context, request *configpb.ReadServiceAccountRequest, ...) (*configpb.ReadServiceAccountResponse, error)
- func (c *Client) ReadServiceAccountCredential(ctx context.Context, request *configpb.ReadServiceAccountCredentialRequest, ...) (*configpb.ReadServiceAccountCredentialResponse, error)
- func (c *Client) RegisterApplicationAgentCredential(ctx context.Context, ...) (*configpb.RegisterApplicationAgentCredentialResponse, error)
- func (c *Client) RegisterServiceAccountCredential(ctx context.Context, request *configpb.RegisterServiceAccountCredentialRequest, ...) (*configpb.RegisterServiceAccountCredentialResponse, error)
- func (c *Client) UpdateApplication(ctx context.Context, request *configpb.UpdateApplicationRequest, ...) (*configpb.UpdateApplicationResponse, error)
- func (c *Client) UpdateApplicationAgent(ctx context.Context, request *configpb.UpdateApplicationAgentRequest, ...) (*configpb.UpdateApplicationAgentResponse, error)
- func (c *Client) UpdateApplicationSpace(ctx context.Context, request *configpb.UpdateApplicationSpaceRequest, ...) (*configpb.UpdateApplicationSpaceResponse, error)
- func (c *Client) UpdateConfigNode(ctx context.Context, req *NodeRequest, opts ...grpc.CallOption) (*configpb.UpdateConfigNodeResponse, error)
- func (c *Client) UpdateServiceAccount(ctx context.Context, request *configpb.UpdateServiceAccountRequest, ...) (*configpb.UpdateServiceAccountResponse, error)
- type NodeRequest
- func NewCreate(name string) (*NodeRequest, error)
- func NewDelete(id string) (*NodeRequest, error)
- func NewListVersions(id string) (*NodeRequest, error)
- func NewRead(id string) (*NodeRequest, error)
- func NewReadWithName(name string) (*NodeRequest, error)
- func NewUpdate(id string) (*NodeRequest, error)
- func (x *NodeRequest) EmptyDescription() *NodeRequest
- func (x *NodeRequest) EmptyDisplayName() *NodeRequest
- func (x *NodeRequest) ForLocation(id string) *NodeRequest
- func (x *NodeRequest) String() string
- func (x *NodeRequest) WithAuditSinkConfig(v *configpb.AuditSinkConfig) *NodeRequest
- func (x *NodeRequest) WithAuthorizationPolicyConfig(v *configpb.AuthorizationPolicyConfig) *NodeRequest
- func (x *NodeRequest) WithBookmarks(bookmarks []string) *NodeRequest
- func (x *NodeRequest) WithConsentConfig(v *configpb.ConsentConfiguration) *NodeRequest
- func (x *NodeRequest) WithDescription(v string) *NodeRequest
- func (x *NodeRequest) WithDisplayName(v string) *NodeRequest
- func (x *NodeRequest) WithExternalDataResolverConfig(v *configpb.ExternalDataResolverConfig) *NodeRequest
- func (x *NodeRequest) WithIdentityMatchingPipelineConfig(v *configpb.IdentityMatchingPipelineConfig) *NodeRequest
- func (x *NodeRequest) WithIngestPipelineConfig(v *configpb.IngestPipelineConfig) *NodeRequest
- func (x *NodeRequest) WithPreCondition(etag string) *NodeRequest
- func (x *NodeRequest) WithTokenIntrospectConfig(v *configpb.TokenIntrospectConfig) *NodeRequest
- func (x *NodeRequest) WithVersion(version int64) *NodeRequest
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func IsValidName ¶
IsValidName checks if name is valid RFC1035 string.
Value can have lowercase letters, digits, or hyphens. It must start with a lowercase letter and end with a letter or number. The minimum length is 2 and the max is 254.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func NewClient ¶
NewClient creates a new Config Management gRPC Client.
Example (Default) ¶
This example demonstrates how to create a new Config Client.
package main import ( "context" "log" "github.com/indykite/indykite-sdk-go/config" ) func main() { client, err := config.NewClient(context.Background()) if err != nil { log.Fatalf("failed to create client %v", err) } _ = client.Close() }
Output:
Example (Options) ¶
This example demonstrates how to create a new Config Client.
package main import ( "context" "log" "github.com/indykite/indykite-sdk-go/config" api "github.com/indykite/indykite-sdk-go/grpc" ) func main() { client, err := config.NewClient(context.Background(), api.WithCredentialsJSON([]byte(`{}`))) if err != nil { log.Fatalf("failed to create client %v", err) } _ = client.Close() }
Output:
func NewTestClient ¶
NewTestClient creates a new Config Management gRPC Client for Testing.
func (*Client) Close ¶
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*Client) CreateApplication ¶
func (c *Client) CreateApplication( ctx context.Context, request *configpb.CreateApplicationRequest, opts ...grpc.CallOption) (*configpb.CreateApplicationResponse, error)
func (*Client) CreateApplicationAgent ¶
func (c *Client) CreateApplicationAgent( ctx context.Context, request *configpb.CreateApplicationAgentRequest, opts ...grpc.CallOption) (*configpb.CreateApplicationAgentResponse, error)
func (*Client) CreateApplicationSpace ¶
func (c *Client) CreateApplicationSpace( ctx context.Context, request *configpb.CreateApplicationSpaceRequest, opts ...grpc.CallOption) (*configpb.CreateApplicationSpaceResponse, error)
func (*Client) CreateConfigNode ¶
func (c *Client) CreateConfigNode(ctx context.Context, request *NodeRequest, opts ...grpc.CallOption) ( *configpb.CreateConfigNodeResponse, error)
func (*Client) CreateServiceAccount ¶
func (c *Client) CreateServiceAccount( ctx context.Context, request *configpb.CreateServiceAccountRequest, opts ...grpc.CallOption) (*configpb.CreateServiceAccountResponse, error)
func (*Client) DeleteApplication ¶
func (c *Client) DeleteApplication( ctx context.Context, request *configpb.DeleteApplicationRequest, opts ...grpc.CallOption) (*configpb.DeleteApplicationResponse, error)
func (*Client) DeleteApplicationAgent ¶
func (c *Client) DeleteApplicationAgent( ctx context.Context, request *configpb.DeleteApplicationAgentRequest, opts ...grpc.CallOption) (*configpb.DeleteApplicationAgentResponse, error)
func (*Client) DeleteApplicationAgentCredential ¶
func (c *Client) DeleteApplicationAgentCredential( ctx context.Context, request *configpb.DeleteApplicationAgentCredentialRequest, opts ...grpc.CallOption, ) (*configpb.DeleteApplicationAgentCredentialResponse, error)
func (*Client) DeleteApplicationSpace ¶
func (c *Client) DeleteApplicationSpace( ctx context.Context, request *configpb.DeleteApplicationSpaceRequest, opts ...grpc.CallOption) (*configpb.DeleteApplicationSpaceResponse, error)
func (*Client) DeleteConfigNode ¶
func (c *Client) DeleteConfigNode(ctx context.Context, req *NodeRequest, opts ...grpc.CallOption) ( *configpb.DeleteConfigNodeResponse, error)
func (*Client) DeleteServiceAccount ¶
func (c *Client) DeleteServiceAccount( ctx context.Context, request *configpb.DeleteServiceAccountRequest, opts ...grpc.CallOption) (*configpb.DeleteServiceAccountResponse, error)
func (*Client) DeleteServiceAccountCredential ¶ added in v0.15.0
func (c *Client) DeleteServiceAccountCredential( ctx context.Context, request *configpb.DeleteServiceAccountCredentialRequest, opts ...grpc.CallOption, ) (*configpb.DeleteServiceAccountCredentialResponse, error)
func (*Client) ListApplicationAgents ¶
func (c *Client) ListApplicationAgents( ctx context.Context, request *configpb.ListApplicationAgentsRequest, opts ...grpc.CallOption, ) (configpb.ConfigManagementAPI_ListApplicationAgentsClient, error)
func (*Client) ListApplicationSpaces ¶
func (c *Client) ListApplicationSpaces( ctx context.Context, request *configpb.ListApplicationSpacesRequest, opts ...grpc.CallOption, ) (configpb.ConfigManagementAPI_ListApplicationSpacesClient, error)
func (*Client) ListApplications ¶
func (c *Client) ListApplications( ctx context.Context, request *configpb.ListApplicationsRequest, opts ...grpc.CallOption, ) (configpb.ConfigManagementAPI_ListApplicationsClient, error)
func (*Client) ListConfigNodeVersions ¶ added in v0.16.0
func (c *Client) ListConfigNodeVersions(ctx context.Context, req *NodeRequest, opts ...grpc.CallOption) ( *configpb.ListConfigNodeVersionsResponse, error)
func (*Client) ReadApplication ¶
func (c *Client) ReadApplication( ctx context.Context, request *configpb.ReadApplicationRequest, opts ...grpc.CallOption) (*configpb.ReadApplicationResponse, error)
func (*Client) ReadApplicationAgent ¶
func (c *Client) ReadApplicationAgent( ctx context.Context, request *configpb.ReadApplicationAgentRequest, opts ...grpc.CallOption) (*configpb.ReadApplicationAgentResponse, error)
func (*Client) ReadApplicationAgentCredential ¶
func (c *Client) ReadApplicationAgentCredential( ctx context.Context, request *configpb.ReadApplicationAgentCredentialRequest, opts ...grpc.CallOption, ) (*configpb.ReadApplicationAgentCredentialResponse, error)
func (*Client) ReadApplicationSpace ¶
func (c *Client) ReadApplicationSpace( ctx context.Context, request *configpb.ReadApplicationSpaceRequest, opts ...grpc.CallOption) (*configpb.ReadApplicationSpaceResponse, error)
func (*Client) ReadConfigNode ¶
func (c *Client) ReadConfigNode(ctx context.Context, req *NodeRequest, opts ...grpc.CallOption) ( *configpb.ReadConfigNodeResponse, error)
func (*Client) ReadCustomer ¶
func (c *Client) ReadCustomer( ctx context.Context, request *configpb.ReadCustomerRequest, opts ...grpc.CallOption) (*configpb.ReadCustomerResponse, error)
func (*Client) ReadServiceAccount ¶
func (c *Client) ReadServiceAccount( ctx context.Context, request *configpb.ReadServiceAccountRequest, opts ...grpc.CallOption) (*configpb.ReadServiceAccountResponse, error)
func (*Client) ReadServiceAccountCredential ¶ added in v0.15.0
func (c *Client) ReadServiceAccountCredential( ctx context.Context, request *configpb.ReadServiceAccountCredentialRequest, opts ...grpc.CallOption, ) (*configpb.ReadServiceAccountCredentialResponse, error)
func (*Client) RegisterApplicationAgentCredential ¶
func (c *Client) RegisterApplicationAgentCredential( ctx context.Context, request *configpb.RegisterApplicationAgentCredentialRequest, opts ...grpc.CallOption, ) (*configpb.RegisterApplicationAgentCredentialResponse, error)
func (*Client) RegisterServiceAccountCredential ¶ added in v0.15.0
func (c *Client) RegisterServiceAccountCredential( ctx context.Context, request *configpb.RegisterServiceAccountCredentialRequest, opts ...grpc.CallOption, ) (*configpb.RegisterServiceAccountCredentialResponse, error)
func (*Client) UpdateApplication ¶
func (c *Client) UpdateApplication( ctx context.Context, request *configpb.UpdateApplicationRequest, opts ...grpc.CallOption) (*configpb.UpdateApplicationResponse, error)
func (*Client) UpdateApplicationAgent ¶
func (c *Client) UpdateApplicationAgent( ctx context.Context, request *configpb.UpdateApplicationAgentRequest, opts ...grpc.CallOption) (*configpb.UpdateApplicationAgentResponse, error)
func (*Client) UpdateApplicationSpace ¶
func (c *Client) UpdateApplicationSpace( ctx context.Context, request *configpb.UpdateApplicationSpaceRequest, opts ...grpc.CallOption) (*configpb.UpdateApplicationSpaceResponse, error)
func (*Client) UpdateConfigNode ¶
func (c *Client) UpdateConfigNode(ctx context.Context, req *NodeRequest, opts ...grpc.CallOption) ( *configpb.UpdateConfigNodeResponse, error)
func (*Client) UpdateServiceAccount ¶
func (c *Client) UpdateServiceAccount( ctx context.Context, request *configpb.UpdateServiceAccountRequest, opts ...grpc.CallOption) (*configpb.UpdateServiceAccountResponse, error)
type NodeRequest ¶
type NodeRequest struct {
// contains filtered or unexported fields
}
NodeRequest is a request builder.
func NewCreate ¶
func NewCreate(name string) (*NodeRequest, error)
func NewDelete ¶
func NewDelete(id string) (*NodeRequest, error)
func NewListVersions ¶ added in v0.16.0
func NewListVersions(id string) (*NodeRequest, error)
func NewRead ¶
func NewRead(id string) (*NodeRequest, error)
func NewReadWithName ¶
func NewReadWithName(name string) (*NodeRequest, error)
func NewUpdate ¶
func NewUpdate(id string) (*NodeRequest, error)
func (*NodeRequest) EmptyDescription ¶
func (x *NodeRequest) EmptyDescription() *NodeRequest
EmptyDescription removes the current description value.
func (*NodeRequest) EmptyDisplayName ¶
func (x *NodeRequest) EmptyDisplayName() *NodeRequest
EmptyDisplayName removes the current displayName value.
func (*NodeRequest) ForLocation ¶
func (x *NodeRequest) ForLocation(id string) *NodeRequest
func (*NodeRequest) String ¶
func (x *NodeRequest) String() string
func (*NodeRequest) WithAuditSinkConfig ¶ added in v0.16.0
func (x *NodeRequest) WithAuditSinkConfig(v *configpb.AuditSinkConfig) *NodeRequest
func (*NodeRequest) WithAuthorizationPolicyConfig ¶
func (x *NodeRequest) WithAuthorizationPolicyConfig(v *configpb.AuthorizationPolicyConfig) *NodeRequest
func (*NodeRequest) WithBookmarks ¶ added in v0.14.3
func (x *NodeRequest) WithBookmarks(bookmarks []string) *NodeRequest
WithBookmarks adds received bookmarks from previous requests. Overwriting previous value if calling multiple times.
func (*NodeRequest) WithConsentConfig ¶ added in v0.25.0
func (x *NodeRequest) WithConsentConfig(v *configpb.ConsentConfiguration) *NodeRequest
func (*NodeRequest) WithDescription ¶
func (x *NodeRequest) WithDescription(v string) *NodeRequest
WithDescription sets the new description value.
func (*NodeRequest) WithDisplayName ¶
func (x *NodeRequest) WithDisplayName(v string) *NodeRequest
WithDisplayName sets the new displayName value.
func (*NodeRequest) WithExternalDataResolverConfig ¶ added in v0.36.0
func (x *NodeRequest) WithExternalDataResolverConfig(v *configpb.ExternalDataResolverConfig) *NodeRequest
func (*NodeRequest) WithIdentityMatchingPipelineConfig ¶ added in v0.36.0
func (x *NodeRequest) WithIdentityMatchingPipelineConfig(v *configpb.IdentityMatchingPipelineConfig) *NodeRequest
func (*NodeRequest) WithIngestPipelineConfig ¶ added in v0.34.0
func (x *NodeRequest) WithIngestPipelineConfig(v *configpb.IngestPipelineConfig) *NodeRequest
func (*NodeRequest) WithPreCondition ¶
func (x *NodeRequest) WithPreCondition(etag string) *NodeRequest
WithPreCondition sets the expected etag to check before modify or delete.
func (*NodeRequest) WithTokenIntrospectConfig ¶ added in v0.29.1
func (x *NodeRequest) WithTokenIntrospectConfig(v *configpb.TokenIntrospectConfig) *NodeRequest
func (*NodeRequest) WithVersion ¶ added in v0.16.0
func (x *NodeRequest) WithVersion(version int64) *NodeRequest