package agentendpoint

import "cloud.google.com/go/osconfig/agentendpoint/apiv1beta"

Index

Examples

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
	LookupEffectiveGuestPolicy []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 Cloud OS Config API.

Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

func NewClient 

func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)

NewClient creates a new agent endpoint service client.

OS Config agent endpoint API.

Example

Code:play  

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.
	}
	// TODO: Use client.
	_ = c
}

func (*Client) Close 

func (c *Client) Close() error

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 the client's connection to the API service.

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

Code:play  

package main

import (
	"context"

	agentendpoint "cloud.google.com/go/osconfig/agentendpoint/apiv1beta"
	agentendpointpb "google.golang.org/genproto/googleapis/cloud/osconfig/agentendpoint/v1beta"
)

func main() {
	// import agentendpointpb "google.golang.org/genproto/googleapis/cloud/osconfig/agentendpoint/v1beta"

	ctx := context.Background()
	c, err := agentendpoint.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}

	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) 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

Code:play  

package main

import (
	"context"

	agentendpoint "cloud.google.com/go/osconfig/agentendpoint/apiv1beta"
	agentendpointpb "google.golang.org/genproto/googleapis/cloud/osconfig/agentendpoint/v1beta"
)

func main() {
	// import agentendpointpb "google.golang.org/genproto/googleapis/cloud/osconfig/agentendpoint/v1beta"

	ctx := context.Background()
	c, err := agentendpoint.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}

	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

Code:play  

package main

import (
	"context"

	agentendpoint "cloud.google.com/go/osconfig/agentendpoint/apiv1beta"
	agentendpointpb "google.golang.org/genproto/googleapis/cloud/osconfig/agentendpoint/v1beta"
)

func main() {
	// import agentendpointpb "google.golang.org/genproto/googleapis/cloud/osconfig/agentendpoint/v1beta"

	ctx := context.Background()
	c, err := agentendpoint.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}

	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

Code:play  

package main

import (
	"context"

	agentendpoint "cloud.google.com/go/osconfig/agentendpoint/apiv1beta"
	agentendpointpb "google.golang.org/genproto/googleapis/cloud/osconfig/agentendpoint/v1beta"
)

func main() {
	// import agentendpointpb "google.golang.org/genproto/googleapis/cloud/osconfig/agentendpoint/v1beta"

	ctx := context.Background()
	c, err := agentendpoint.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}

	req := &agentendpointpb.StartNextTaskRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.StartNextTask(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Source Files

agent_endpoint_client.go doc.go

Version
v0.50.0
Published
Dec 17, 2019
Platform
js/wasm
Imports
11 packages
Last checked
20 minutes ago –

Tools for package owners.