- 0.115.1 (latest)
- 0.115.0
- 0.114.0
- 0.113.0
- 0.112.2
- 0.111.0
- 0.110.10
- 0.109.0
- 0.108.0
- 0.107.0
- 0.106.0
- 0.105.0
- 0.104.0
- 0.103.0
- 0.102.1
- 0.101.1
- 0.100.2
- 0.99.0
- 0.98.0
- 0.97.0
- 0.96.0
- 0.95.0
- 0.94.1
- 0.93.3
- 0.92.3
- 0.91.1
- 0.90.0
- 0.89.0
- 0.88.0
- 0.87.0
- 0.86.0
- 0.85.0
- 0.84.0
- 0.83.0
- 0.82.0
- 0.81.0
- 0.80.0
- 0.79.0
- 0.78.0
- 0.77.0
- 0.76.0
- 0.75.0
Package agentendpoint is an auto-generated package for the Cloud OS Config API.
OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.
NOTE: This package is in beta. It is not stable, and may be subject to changes.
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.
For information about setting deadlines, reusing contexts, and more please visit https://pkg.go.dev/cloud.google.com/go.
Functions
func DefaultAuthScopes
func DefaultAuthScopes() []string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
CallOptions
type CallOptions struct {
ReceiveTaskNotification []gax.CallOption
StartNextTask []gax.CallOption
ReportTaskProgress []gax.CallOption
ReportTaskComplete []gax.CallOption
LookupEffectiveGuestPolicy []gax.CallOption
RegisterAgent []gax.CallOption
}
CallOptions contains the retry settings for each method of Client.
Client
type Client struct {
// The call options for this service.
CallOptions *CallOptions
// contains filtered or unexported fields
}
Client is a client for interacting with Cloud 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/apiv1beta"
)
func main() {
ctx := context.Background()
c, err := agentendpoint.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
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
func (c *Client) Connection() *grpc.ClientConn
Connection returns a connection to the API service.
Deprecated.
func (*Client) LookupEffectiveGuestPolicy
func (c *Client) LookupEffectiveGuestPolicy(ctx context.Context, req *agentendpointpb.LookupEffectiveGuestPolicyRequest, opts ...gax.CallOption) (*agentendpointpb.EffectiveGuestPolicy, error)
LookupEffectiveGuestPolicy lookup the effective guest policy that applies to a VM instance. This lookup merges all policies that are assigned to the instance ancestry.
Example
package main
import (
"context"
agentendpoint "cloud.google.com/go/osconfig/agentendpoint/apiv1beta"
agentendpointpb "google.golang.org/genproto/googleapis/cloud/osconfig/agentendpoint/v1beta"
)
func main() {
ctx := context.Background()
c, err := agentendpoint.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &agentendpointpb.LookupEffectiveGuestPolicyRequest{
// TODO: Fill request struct fields.
}
resp, err := c.LookupEffectiveGuestPolicy(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
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/apiv1beta"
agentendpointpb "google.golang.org/genproto/googleapis/cloud/osconfig/agentendpoint/v1beta"
)
func main() {
ctx := context.Background()
c, err := agentendpoint.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &agentendpointpb.RegisterAgentRequest{
// TODO: Fill request struct fields.
}
resp, err := c.RegisterAgent(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
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/apiv1beta"
agentendpointpb "google.golang.org/genproto/googleapis/cloud/osconfig/agentendpoint/v1beta"
)
func main() {
ctx := context.Background()
c, err := agentendpoint.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &agentendpointpb.ReportTaskCompleteRequest{
// TODO: Fill request struct fields.
}
resp, err := c.ReportTaskComplete(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
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/apiv1beta"
agentendpointpb "google.golang.org/genproto/googleapis/cloud/osconfig/agentendpoint/v1beta"
)
func main() {
ctx := context.Background()
c, err := agentendpoint.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &agentendpointpb.ReportTaskProgressRequest{
// TODO: Fill request struct fields.
}
resp, err := c.ReportTaskProgress(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
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/apiv1beta"
agentendpointpb "google.golang.org/genproto/googleapis/cloud/osconfig/agentendpoint/v1beta"
)
func main() {
ctx := context.Background()
c, err := agentendpoint.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &agentendpointpb.StartNextTaskRequest{
// TODO: Fill request struct fields.
}
resp, err := c.StartNextTask(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}