Documentation ¶
Overview ¶
Package agentendpoint is an auto-generated package for the OS Config API.
OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.
General documentation ¶
For information that is relevant for all client libraries please reference https://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on this page includes:
- Authentication and Authorization
- Timeouts and Cancellation
- Testing against Client Libraries
- Debugging Client Libraries
- Inspecting errors
Example usage ¶
To get started with this package, create a client.
ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := agentendpoint.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close()
The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.
Using the Client ¶
The following is an example of making an API call with the newly created client.
Use of Context ¶
The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.
To close the open connection, use the Close() method.
Index ¶
- func DefaultAuthScopes() []string
- type CallOptions
- type Client
- func (c *Client) Close() error
- func (c *Client) Connection() *grpc.ClientConndeprecated
- func (c *Client) ReceiveTaskNotification(ctx context.Context, req *agentendpointpb.ReceiveTaskNotificationRequest, ...) (agentendpointpb.AgentEndpointService_ReceiveTaskNotificationClient, error)
- func (c *Client) RegisterAgent(ctx context.Context, req *agentendpointpb.RegisterAgentRequest, ...) (*agentendpointpb.RegisterAgentResponse, error)
- func (c *Client) ReportInventory(ctx context.Context, req *agentendpointpb.ReportInventoryRequest, ...) (*agentendpointpb.ReportInventoryResponse, error)
- func (c *Client) ReportTaskComplete(ctx context.Context, req *agentendpointpb.ReportTaskCompleteRequest, ...) (*agentendpointpb.ReportTaskCompleteResponse, error)
- func (c *Client) ReportTaskProgress(ctx context.Context, req *agentendpointpb.ReportTaskProgressRequest, ...) (*agentendpointpb.ReportTaskProgressResponse, error)
- func (c *Client) StartNextTask(ctx context.Context, req *agentendpointpb.StartNextTaskRequest, ...) (*agentendpointpb.StartNextTaskResponse, error)
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DefaultAuthScopes ¶
func DefaultAuthScopes() []string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
Types ¶
type CallOptions ¶
type CallOptions struct { ReceiveTaskNotification []gax.CallOption StartNextTask []gax.CallOption ReportTaskProgress []gax.CallOption ReportTaskComplete []gax.CallOption RegisterAgent []gax.CallOption ReportInventory []gax.CallOption }
CallOptions contains the retry settings for each method of Client.
type Client ¶
type Client struct { // The call options for this service. CallOptions *CallOptions // contains filtered or unexported fields }
Client is a client for interacting with OS Config API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
OS Config agent endpoint API.
func NewClient ¶
NewClient creates a new agent endpoint service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
OS Config agent endpoint API.
Example ¶
package main import ( "context" agentendpoint "cloud.google.com/go/osconfig/agentendpoint/apiv1" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := agentendpoint.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() // TODO: Use client. _ = c }
Output:
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) Connection
deprecated
func (c *Client) Connection() *grpc.ClientConn
Connection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*Client) ReceiveTaskNotification ¶
func (c *Client) ReceiveTaskNotification(ctx context.Context, req *agentendpointpb.ReceiveTaskNotificationRequest, opts ...gax.CallOption) (agentendpointpb.AgentEndpointService_ReceiveTaskNotificationClient, error)
ReceiveTaskNotification stream established by client to receive Task notifications.
func (*Client) RegisterAgent ¶
func (c *Client) RegisterAgent(ctx context.Context, req *agentendpointpb.RegisterAgentRequest, opts ...gax.CallOption) (*agentendpointpb.RegisterAgentResponse, error)
RegisterAgent registers the agent running on the VM.
Example ¶
package main import ( "context" agentendpoint "cloud.google.com/go/osconfig/agentendpoint/apiv1" agentendpointpb "cloud.google.com/go/osconfig/agentendpoint/apiv1/agentendpointpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := agentendpoint.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &agentendpointpb.RegisterAgentRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/osconfig/agentendpoint/apiv1/agentendpointpb#RegisterAgentRequest. } resp, err := c.RegisterAgent(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) ReportInventory ¶
func (c *Client) ReportInventory(ctx context.Context, req *agentendpointpb.ReportInventoryRequest, opts ...gax.CallOption) (*agentendpointpb.ReportInventoryResponse, error)
ReportInventory reports the VMs current inventory.
Example ¶
package main import ( "context" agentendpoint "cloud.google.com/go/osconfig/agentendpoint/apiv1" agentendpointpb "cloud.google.com/go/osconfig/agentendpoint/apiv1/agentendpointpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := agentendpoint.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &agentendpointpb.ReportInventoryRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/osconfig/agentendpoint/apiv1/agentendpointpb#ReportInventoryRequest. } resp, err := c.ReportInventory(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) ReportTaskComplete ¶
func (c *Client) ReportTaskComplete(ctx context.Context, req *agentendpointpb.ReportTaskCompleteRequest, opts ...gax.CallOption) (*agentendpointpb.ReportTaskCompleteResponse, error)
ReportTaskComplete signals that the task execution is complete and optionally returns the next task.
Example ¶
package main import ( "context" agentendpoint "cloud.google.com/go/osconfig/agentendpoint/apiv1" agentendpointpb "cloud.google.com/go/osconfig/agentendpoint/apiv1/agentendpointpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := agentendpoint.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &agentendpointpb.ReportTaskCompleteRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/osconfig/agentendpoint/apiv1/agentendpointpb#ReportTaskCompleteRequest. } resp, err := c.ReportTaskComplete(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) ReportTaskProgress ¶
func (c *Client) ReportTaskProgress(ctx context.Context, req *agentendpointpb.ReportTaskProgressRequest, opts ...gax.CallOption) (*agentendpointpb.ReportTaskProgressResponse, error)
ReportTaskProgress signals an intermediary progress checkpoint in task execution.
Example ¶
package main import ( "context" agentendpoint "cloud.google.com/go/osconfig/agentendpoint/apiv1" agentendpointpb "cloud.google.com/go/osconfig/agentendpoint/apiv1/agentendpointpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := agentendpoint.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &agentendpointpb.ReportTaskProgressRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/osconfig/agentendpoint/apiv1/agentendpointpb#ReportTaskProgressRequest. } resp, err := c.ReportTaskProgress(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) StartNextTask ¶
func (c *Client) StartNextTask(ctx context.Context, req *agentendpointpb.StartNextTaskRequest, opts ...gax.CallOption) (*agentendpointpb.StartNextTaskResponse, error)
StartNextTask signals the start of a task execution and returns the task info.
Example ¶
package main import ( "context" agentendpoint "cloud.google.com/go/osconfig/agentendpoint/apiv1" agentendpointpb "cloud.google.com/go/osconfig/agentendpoint/apiv1/agentendpointpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := agentendpoint.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &agentendpointpb.StartNextTaskRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/osconfig/agentendpoint/apiv1/agentendpointpb#StartNextTaskRequest. } resp, err := c.StartNextTask(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output: