OS Config API v1beta - Package cloud.google.com/go/osconfig/apiv1beta (v0.77.0)

Package osconfig 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.

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 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 
  
 { 
  
 ExecutePatchJob 
  
 [] 
  gax 
 
 . 
  CallOption 
 
  
 GetPatchJob 
  
 [] 
  gax 
 
 . 
  CallOption 
 
  
 CancelPatchJob 
  
 [] 
  gax 
 
 . 
  CallOption 
 
  
 ListPatchJobs 
  
 [] 
  gax 
 
 . 
  CallOption 
 
  
 ListPatchJobInstanceDetails 
  
 [] 
  gax 
 
 . 
  CallOption 
 
  
 CreatePatchDeployment 
  
 [] 
  gax 
 
 . 
  CallOption 
 
  
 GetPatchDeployment 
  
 [] 
  gax 
 
 . 
  CallOption 
 
  
 ListPatchDeployments 
  
 [] 
  gax 
 
 . 
  CallOption 
 
  
 DeletePatchDeployment 
  
 [] 
  gax 
 
 . 
  CallOption 
 
  
 CreateGuestPolicy 
  
 [] 
  gax 
 
 . 
  CallOption 
 
  
 GetGuestPolicy 
  
 [] 
  gax 
 
 . 
  CallOption 
 
  
 ListGuestPolicies 
  
 [] 
  gax 
 
 . 
  CallOption 
 
  
 UpdateGuestPolicy 
  
 [] 
  gax 
 
 . 
  CallOption 
 
  
 DeleteGuestPolicy 
  
 [] 
  gax 
 
 . 
  CallOption 
 
  
 LookupEffectiveGuestPolicy 
  
 [] 
  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.

func NewClient

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

NewClient creates a new os config service client.

OS Config API

The OS Config service is a server-side component that you can use to manage package installations and patch jobs for virtual machine instances.

Example

  package 
  
 main 
 import 
  
 ( 
  
 "context" 
  
 osconfig 
  
 "cloud.google.com/go/osconfig/apiv1beta" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 osconfig 
 . 
  NewClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 // TODO: Use client. 
  
 _ 
  
 = 
  
 c 
 } 
 

func (*Client) CancelPatchJob

CancelPatchJob cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted.

Example

  package 
  
 main 
 import 
  
 ( 
  
 "context" 
  
 osconfig 
  
 "cloud.google.com/go/osconfig/apiv1beta" 
  
 osconfigpb 
  
 "google.golang.org/genproto/googleapis/cloud/osconfig/v1beta" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 // import osconfigpb "google.golang.org/genproto/googleapis/cloud/osconfig/v1beta" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 osconfig 
 . 
  NewClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 req 
  
 := 
  
& osconfigpb 
 . 
  CancelPatchJobRequest 
 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 resp 
 , 
  
 err 
  
 := 
  
 c 
 . 
 CancelPatchJob 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 // TODO: Use resp. 
  
 _ 
  
 = 
  
 resp 
 } 
 

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 a connection to the API service.

Deprecated.

func (*Client) CreateGuestPolicy

CreateGuestPolicy create an OS Config guest policy.

Example

  package 
  
 main 
 import 
  
 ( 
  
 "context" 
  
 osconfig 
  
 "cloud.google.com/go/osconfig/apiv1beta" 
  
 osconfigpb 
  
 "google.golang.org/genproto/googleapis/cloud/osconfig/v1beta" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 // import osconfigpb "google.golang.org/genproto/googleapis/cloud/osconfig/v1beta" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 osconfig 
 . 
  NewClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 req 
  
 := 
  
& osconfigpb 
 . 
  CreateGuestPolicyRequest 
 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 resp 
 , 
  
 err 
  
 := 
  
 c 
 . 
 CreateGuestPolicy 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 // TODO: Use resp. 
  
 _ 
  
 = 
  
 resp 
 } 
 

func (*Client) CreatePatchDeployment

CreatePatchDeployment create an OS Config patch deployment.

Example

  package 
  
 main 
 import 
  
 ( 
  
 "context" 
  
 osconfig 
  
 "cloud.google.com/go/osconfig/apiv1beta" 
  
 osconfigpb 
  
 "google.golang.org/genproto/googleapis/cloud/osconfig/v1beta" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 // import osconfigpb "google.golang.org/genproto/googleapis/cloud/osconfig/v1beta" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 osconfig 
 . 
  NewClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 req 
  
 := 
  
& osconfigpb 
 . 
  CreatePatchDeploymentRequest 
 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 resp 
 , 
  
 err 
  
 := 
  
 c 
 . 
 CreatePatchDeployment 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 // TODO: Use resp. 
  
 _ 
  
 = 
  
 resp 
 } 
 

func (*Client) DeleteGuestPolicy

DeleteGuestPolicy delete an OS Config guest policy.

Example

  package 
  
 main 
 import 
  
 ( 
  
 "context" 
  
 osconfig 
  
 "cloud.google.com/go/osconfig/apiv1beta" 
  
 osconfigpb 
  
 "google.golang.org/genproto/googleapis/cloud/osconfig/v1beta" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 osconfig 
 . 
  NewClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 req 
  
 := 
  
& osconfigpb 
 . 
  DeleteGuestPolicyRequest 
 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 err 
  
 = 
  
 c 
 . 
 DeleteGuestPolicy 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
 } 
 

func (*Client) DeletePatchDeployment

DeletePatchDeployment delete an OS Config patch deployment.

Example

  package 
  
 main 
 import 
  
 ( 
  
 "context" 
  
 osconfig 
  
 "cloud.google.com/go/osconfig/apiv1beta" 
  
 osconfigpb 
  
 "google.golang.org/genproto/googleapis/cloud/osconfig/v1beta" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 osconfig 
 . 
  NewClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 req 
  
 := 
  
& osconfigpb 
 . 
  DeletePatchDeploymentRequest 
 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 err 
  
 = 
  
 c 
 . 
 DeletePatchDeployment 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
 } 
 

func (*Client) ExecutePatchJob

ExecutePatchJob patch VM instances by creating and running a patch job.

Example

  package 
  
 main 
 import 
  
 ( 
  
 "context" 
  
 osconfig 
  
 "cloud.google.com/go/osconfig/apiv1beta" 
  
 osconfigpb 
  
 "google.golang.org/genproto/googleapis/cloud/osconfig/v1beta" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 // import osconfigpb "google.golang.org/genproto/googleapis/cloud/osconfig/v1beta" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 osconfig 
 . 
  NewClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 req 
  
 := 
  
& osconfigpb 
 . 
  ExecutePatchJobRequest 
 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 resp 
 , 
  
 err 
  
 := 
  
 c 
 . 
 ExecutePatchJob 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 // TODO: Use resp. 
  
 _ 
  
 = 
  
 resp 
 } 
 

func (*Client) GetGuestPolicy

GetGuestPolicy get an OS Config guest policy.

Example

  package 
  
 main 
 import 
  
 ( 
  
 "context" 
  
 osconfig 
  
 "cloud.google.com/go/osconfig/apiv1beta" 
  
 osconfigpb 
  
 "google.golang.org/genproto/googleapis/cloud/osconfig/v1beta" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 // import osconfigpb "google.golang.org/genproto/googleapis/cloud/osconfig/v1beta" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 osconfig 
 . 
  NewClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 req 
  
 := 
  
& osconfigpb 
 . 
  GetGuestPolicyRequest 
 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 resp 
 , 
  
 err 
  
 := 
  
 c 
 . 
 GetGuestPolicy 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 // TODO: Use resp. 
  
 _ 
  
 = 
  
 resp 
 } 
 

func (*Client) GetPatchDeployment

GetPatchDeployment get an OS Config patch deployment.

Example

  package 
  
 main 
 import 
  
 ( 
  
 "context" 
  
 osconfig 
  
 "cloud.google.com/go/osconfig/apiv1beta" 
  
 osconfigpb 
  
 "google.golang.org/genproto/googleapis/cloud/osconfig/v1beta" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 // import osconfigpb "google.golang.org/genproto/googleapis/cloud/osconfig/v1beta" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 osconfig 
 . 
  NewClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 req 
  
 := 
  
& osconfigpb 
 . 
  GetPatchDeploymentRequest 
 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 resp 
 , 
  
 err 
  
 := 
  
 c 
 . 
 GetPatchDeployment 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 // TODO: Use resp. 
  
 _ 
  
 = 
  
 resp 
 } 
 

func (*Client) GetPatchJob

GetPatchJob get the patch job. This can be used to track the progress of an ongoing patch job or review the details of completed jobs.

Example

  package 
  
 main 
 import 
  
 ( 
  
 "context" 
  
 osconfig 
  
 "cloud.google.com/go/osconfig/apiv1beta" 
  
 osconfigpb 
  
 "google.golang.org/genproto/googleapis/cloud/osconfig/v1beta" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 // import osconfigpb "google.golang.org/genproto/googleapis/cloud/osconfig/v1beta" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 osconfig 
 . 
  NewClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 req 
  
 := 
  
& osconfigpb 
 . 
  GetPatchJobRequest 
 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 resp 
 , 
  
 err 
  
 := 
  
 c 
 . 
 GetPatchJob 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 // TODO: Use resp. 
  
 _ 
  
 = 
  
 resp 
 } 
 

func (*Client) ListGuestPolicies

ListGuestPolicies get a page of OS Config guest policies.

Example

  package 
  
 main 
 import 
  
 ( 
  
 "context" 
  
 osconfig 
  
 "cloud.google.com/go/osconfig/apiv1beta" 
  
 "google.golang.org/api/iterator" 
  
 osconfigpb 
  
 "google.golang.org/genproto/googleapis/cloud/osconfig/v1beta" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 // import osconfigpb "google.golang.org/genproto/googleapis/cloud/osconfig/v1beta" 
  
 // import "google.golang.org/api/iterator" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 osconfig 
 . 
  NewClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 req 
  
 := 
  
& osconfigpb 
 . 
  ListGuestPoliciesRequest 
 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 it 
  
 := 
  
 c 
 . 
 ListGuestPolicies 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 for 
  
 { 
  
 resp 
 , 
  
 err 
  
 := 
  
 it 
 . 
 Next 
 () 
  
 if 
  
 err 
  
 == 
  
 iterator 
 . 
 Done 
  
 { 
  
 break 
  
 } 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 // TODO: Use resp. 
  
 _ 
  
 = 
  
 resp 
  
 } 
 } 
 

func (*Client) ListPatchDeployments

ListPatchDeployments get a page of OS Config patch deployments.

Example

  package 
  
 main 
 import 
  
 ( 
  
 "context" 
  
 osconfig 
  
 "cloud.google.com/go/osconfig/apiv1beta" 
  
 "google.golang.org/api/iterator" 
  
 osconfigpb 
  
 "google.golang.org/genproto/googleapis/cloud/osconfig/v1beta" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 // import osconfigpb "google.golang.org/genproto/googleapis/cloud/osconfig/v1beta" 
  
 // import "google.golang.org/api/iterator" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 osconfig 
 . 
  NewClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 req 
  
 := 
  
& osconfigpb 
 . 
  ListPatchDeploymentsRequest 
 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 it 
  
 := 
  
 c 
 . 
 ListPatchDeployments 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 for 
  
 { 
  
 resp 
 , 
  
 err 
  
 := 
  
 it 
 . 
 Next 
 () 
  
 if 
  
 err 
  
 == 
  
 iterator 
 . 
 Done 
  
 { 
  
 break 
  
 } 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 // TODO: Use resp. 
  
 _ 
  
 = 
  
 resp 
  
 } 
 } 
 

func (*Client) ListPatchJobInstanceDetails

ListPatchJobInstanceDetails get a list of instance details for a given patch job.

Example

  package 
  
 main 
 import 
  
 ( 
  
 "context" 
  
 osconfig 
  
 "cloud.google.com/go/osconfig/apiv1beta" 
  
 "google.golang.org/api/iterator" 
  
 osconfigpb 
  
 "google.golang.org/genproto/googleapis/cloud/osconfig/v1beta" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 // import osconfigpb "google.golang.org/genproto/googleapis/cloud/osconfig/v1beta" 
  
 // import "google.golang.org/api/iterator" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 osconfig 
 . 
  NewClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 req 
  
 := 
  
& osconfigpb 
 . 
  ListPatchJobInstanceDetailsRequest 
 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 it 
  
 := 
  
 c 
 . 
 ListPatchJobInstanceDetails 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 for 
  
 { 
  
 resp 
 , 
  
 err 
  
 := 
  
 it 
 . 
 Next 
 () 
  
 if 
  
 err 
  
 == 
  
 iterator 
 . 
 Done 
  
 { 
  
 break 
  
 } 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 // TODO: Use resp. 
  
 _ 
  
 = 
  
 resp 
  
 } 
 } 
 

func (*Client) ListPatchJobs

ListPatchJobs get a list of patch jobs.

Example

  package 
  
 main 
 import 
  
 ( 
  
 "context" 
  
 osconfig 
  
 "cloud.google.com/go/osconfig/apiv1beta" 
  
 "google.golang.org/api/iterator" 
  
 osconfigpb 
  
 "google.golang.org/genproto/googleapis/cloud/osconfig/v1beta" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 // import osconfigpb "google.golang.org/genproto/googleapis/cloud/osconfig/v1beta" 
  
 // import "google.golang.org/api/iterator" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 osconfig 
 . 
  NewClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 req 
  
 := 
  
& osconfigpb 
 . 
  ListPatchJobsRequest 
 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 it 
  
 := 
  
 c 
 . 
 ListPatchJobs 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 for 
  
 { 
  
 resp 
 , 
  
 err 
  
 := 
  
 it 
 . 
 Next 
 () 
  
 if 
  
 err 
  
 == 
  
 iterator 
 . 
 Done 
  
 { 
  
 break 
  
 } 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 // TODO: Use resp. 
  
 _ 
  
 = 
  
 resp 
  
 } 
 } 
 

func (*Client) LookupEffectiveGuestPolicy

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" 
  
 osconfig 
  
 "cloud.google.com/go/osconfig/apiv1beta" 
  
 osconfigpb 
  
 "google.golang.org/genproto/googleapis/cloud/osconfig/v1beta" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 // import osconfigpb "google.golang.org/genproto/googleapis/cloud/osconfig/v1beta" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 osconfig 
 . 
  NewClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 req 
  
 := 
  
& osconfigpb 
 . 
  LookupEffectiveGuestPolicyRequest 
 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 resp 
 , 
  
 err 
  
 := 
  
 c 
 . 
 LookupEffectiveGuestPolicy 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 // TODO: Use resp. 
  
 _ 
  
 = 
  
 resp 
 } 
 

func (*Client) UpdateGuestPolicy

UpdateGuestPolicy update an OS Config guest policy.

Example

  package 
  
 main 
 import 
  
 ( 
  
 "context" 
  
 osconfig 
  
 "cloud.google.com/go/osconfig/apiv1beta" 
  
 osconfigpb 
  
 "google.golang.org/genproto/googleapis/cloud/osconfig/v1beta" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 // import osconfigpb "google.golang.org/genproto/googleapis/cloud/osconfig/v1beta" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 osconfig 
 . 
  NewClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 req 
  
 := 
  
& osconfigpb 
 . 
  UpdateGuestPolicyRequest 
 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 resp 
 , 
  
 err 
  
 := 
  
 c 
 . 
 UpdateGuestPolicy 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 // TODO: Use resp. 
  
 _ 
  
 = 
  
 resp 
 } 
 

GuestPolicyIterator

  type 
  
 GuestPolicyIterator 
  
 struct 
  
 { 
  
 // Response is the raw response for the current page. 
  
 // It must be cast to the RPC response type. 
  
 // Calling Next() or InternalFetch() updates this value. 
  
 Response 
  
 interface 
 {} 
  
 // InternalFetch is for use by the Google Cloud Libraries only. 
  
 // It is not part of the stable interface of this package. 
  
 // 
  
 // InternalFetch returns results from a single call to the underlying RPC. 
  
 // The number of results is no greater than pageSize. 
  
 // If there are no more results, nextPageToken is empty and err is nil. 
  
 InternalFetch 
  
 func 
 ( 
 pageSize 
  
  int 
 
 , 
  
 pageToken 
  
  string 
 
 ) 
  
 ( 
 results 
  
 [] 
 * 
  osconfigpb 
 
 . 
  GuestPolicy 
 
 , 
  
 nextPageToken 
  
  string 
 
 , 
  
 err 
  
  error 
 
 ) 
  
 // contains filtered or unexported fields 
 } 
 

GuestPolicyIterator manages a stream of *osconfigpb.GuestPolicy.

func (*GuestPolicyIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*GuestPolicyIterator) PageInfo

  func 
  
 ( 
 it 
  
 * 
  GuestPolicyIterator 
 
 ) 
  
 PageInfo 
 () 
  
 * 
  iterator 
 
 . 
  PageInfo 
 
 

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

PatchDeploymentIterator

  type 
  
 PatchDeploymentIterator 
  
 struct 
  
 { 
  
 // Response is the raw response for the current page. 
  
 // It must be cast to the RPC response type. 
  
 // Calling Next() or InternalFetch() updates this value. 
  
 Response 
  
 interface 
 {} 
  
 // InternalFetch is for use by the Google Cloud Libraries only. 
  
 // It is not part of the stable interface of this package. 
  
 // 
  
 // InternalFetch returns results from a single call to the underlying RPC. 
  
 // The number of results is no greater than pageSize. 
  
 // If there are no more results, nextPageToken is empty and err is nil. 
  
 InternalFetch 
  
 func 
 ( 
 pageSize 
  
  int 
 
 , 
  
 pageToken 
  
  string 
 
 ) 
  
 ( 
 results 
  
 [] 
 * 
  osconfigpb 
 
 . 
  PatchDeployment 
 
 , 
  
 nextPageToken 
  
  string 
 
 , 
  
 err 
  
  error 
 
 ) 
  
 // contains filtered or unexported fields 
 } 
 

PatchDeploymentIterator manages a stream of *osconfigpb.PatchDeployment.

func (*PatchDeploymentIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*PatchDeploymentIterator) PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

PatchJobInstanceDetailsIterator

  type 
  
 PatchJobInstanceDetailsIterator 
  
 struct 
  
 { 
  
 // Response is the raw response for the current page. 
  
 // It must be cast to the RPC response type. 
  
 // Calling Next() or InternalFetch() updates this value. 
  
 Response 
  
 interface 
 {} 
  
 // InternalFetch is for use by the Google Cloud Libraries only. 
  
 // It is not part of the stable interface of this package. 
  
 // 
  
 // InternalFetch returns results from a single call to the underlying RPC. 
  
 // The number of results is no greater than pageSize. 
  
 // If there are no more results, nextPageToken is empty and err is nil. 
  
 InternalFetch 
  
 func 
 ( 
 pageSize 
  
  int 
 
 , 
  
 pageToken 
  
  string 
 
 ) 
  
 ( 
 results 
  
 [] 
 * 
  osconfigpb 
 
 . 
  PatchJobInstanceDetails 
 
 , 
  
 nextPageToken 
  
  string 
 
 , 
  
 err 
  
  error 
 
 ) 
  
 // contains filtered or unexported fields 
 } 
 

PatchJobInstanceDetailsIterator manages a stream of *osconfigpb.PatchJobInstanceDetails.

func (*PatchJobInstanceDetailsIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*PatchJobInstanceDetailsIterator) PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

PatchJobIterator

  type 
  
 PatchJobIterator 
  
 struct 
  
 { 
  
 // Response is the raw response for the current page. 
  
 // It must be cast to the RPC response type. 
  
 // Calling Next() or InternalFetch() updates this value. 
  
 Response 
  
 interface 
 {} 
  
 // InternalFetch is for use by the Google Cloud Libraries only. 
  
 // It is not part of the stable interface of this package. 
  
 // 
  
 // InternalFetch returns results from a single call to the underlying RPC. 
  
 // The number of results is no greater than pageSize. 
  
 // If there are no more results, nextPageToken is empty and err is nil. 
  
 InternalFetch 
  
 func 
 ( 
 pageSize 
  
  int 
 
 , 
  
 pageToken 
  
  string 
 
 ) 
  
 ( 
 results 
  
 [] 
 * 
  osconfigpb 
 
 . 
  PatchJob 
 
 , 
  
 nextPageToken 
  
  string 
 
 , 
  
 err 
  
  error 
 
 ) 
  
 // contains filtered or unexported fields 
 } 
 

PatchJobIterator manages a stream of *osconfigpb.PatchJob.

func (*PatchJobIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*PatchJobIterator) PageInfo

  func 
  
 ( 
 it 
  
 * 
  PatchJobIterator 
 
 ) 
  
 PageInfo 
 () 
  
 * 
  iterator 
 
 . 
  PageInfo 
 
 

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

Create a Mobile Website
View Site in Mobile | Classic
Share by: