Package osconfig 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.
NOTE : This package is in beta . It is not stable , and may be subject to changes .
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.
// go get cloud.google.com/go/osconfig/apiv1beta@latest 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 := osconfig . 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, mentioned above.
req := & osconfigpb . CancelPatchJobRequest { // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/osconfig/apiv1beta/osconfigpb#CancelPatchJobRequest. } resp , err := c . CancelPatchJob ( ctx , req ) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp
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.
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
UpdatePatchDeployment
[]
gax
.
CallOption
PausePatchDeployment
[]
gax
.
CallOption
ResumePatchDeployment
[]
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 OS Config API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
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.
func NewClient
NewClient creates a new os config 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 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
()
// 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
:=
osconfig
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func NewRESTClient
NewRESTClient creates a new os config service rest 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
()
// 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
:=
osconfig
.
NewRESTClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func (*Client) CancelPatchJob
func
(
c
*
Client
)
CancelPatchJob
(
ctx
context
.
Context
,
req
*
osconfigpb
.
CancelPatchJobRequest
,
opts
...
gax
.
CallOption
)
(
*
osconfigpb
.
PatchJob
,
error
)
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
"cloud.google.com/go/osconfig/apiv1beta/osconfigpb"
)
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
:=
osconfig
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& osconfigpb
.
CancelPatchJobRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/osconfig/apiv1beta/osconfigpb#CancelPatchJobRequest.
}
resp
,
err
:=
c
.
CancelPatchJob
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
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) CreateGuestPolicy
func
(
c
*
Client
)
CreateGuestPolicy
(
ctx
context
.
Context
,
req
*
osconfigpb
.
CreateGuestPolicyRequest
,
opts
...
gax
.
CallOption
)
(
*
osconfigpb
.
GuestPolicy
,
error
)
CreateGuestPolicy create an OS Config guest policy.
Example
package
main
import
(
"context"
osconfig
"cloud.google.com/go/osconfig/apiv1beta"
osconfigpb
"cloud.google.com/go/osconfig/apiv1beta/osconfigpb"
)
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
:=
osconfig
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& osconfigpb
.
CreateGuestPolicyRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/osconfig/apiv1beta/osconfigpb#CreateGuestPolicyRequest.
}
resp
,
err
:=
c
.
CreateGuestPolicy
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) CreatePatchDeployment
func
(
c
*
Client
)
CreatePatchDeployment
(
ctx
context
.
Context
,
req
*
osconfigpb
.
CreatePatchDeploymentRequest
,
opts
...
gax
.
CallOption
)
(
*
osconfigpb
.
PatchDeployment
,
error
)
CreatePatchDeployment create an OS Config patch deployment.
Example
package
main
import
(
"context"
osconfig
"cloud.google.com/go/osconfig/apiv1beta"
osconfigpb
"cloud.google.com/go/osconfig/apiv1beta/osconfigpb"
)
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
:=
osconfig
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& osconfigpb
.
CreatePatchDeploymentRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/osconfig/apiv1beta/osconfigpb#CreatePatchDeploymentRequest.
}
resp
,
err
:=
c
.
CreatePatchDeployment
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) DeleteGuestPolicy
func
(
c
*
Client
)
DeleteGuestPolicy
(
ctx
context
.
Context
,
req
*
osconfigpb
.
DeleteGuestPolicyRequest
,
opts
...
gax
.
CallOption
)
error
DeleteGuestPolicy delete an OS Config guest policy.
Example
package
main
import
(
"context"
osconfig
"cloud.google.com/go/osconfig/apiv1beta"
osconfigpb
"cloud.google.com/go/osconfig/apiv1beta/osconfigpb"
)
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
:=
osconfig
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& osconfigpb
.
DeleteGuestPolicyRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/osconfig/apiv1beta/osconfigpb#DeleteGuestPolicyRequest.
}
err
=
c
.
DeleteGuestPolicy
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*Client) DeletePatchDeployment
func
(
c
*
Client
)
DeletePatchDeployment
(
ctx
context
.
Context
,
req
*
osconfigpb
.
DeletePatchDeploymentRequest
,
opts
...
gax
.
CallOption
)
error
DeletePatchDeployment delete an OS Config patch deployment.
Example
package
main
import
(
"context"
osconfig
"cloud.google.com/go/osconfig/apiv1beta"
osconfigpb
"cloud.google.com/go/osconfig/apiv1beta/osconfigpb"
)
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
:=
osconfig
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& osconfigpb
.
DeletePatchDeploymentRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/osconfig/apiv1beta/osconfigpb#DeletePatchDeploymentRequest.
}
err
=
c
.
DeletePatchDeployment
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*Client) ExecutePatchJob
func
(
c
*
Client
)
ExecutePatchJob
(
ctx
context
.
Context
,
req
*
osconfigpb
.
ExecutePatchJobRequest
,
opts
...
gax
.
CallOption
)
(
*
osconfigpb
.
PatchJob
,
error
)
ExecutePatchJob patch VM instances by creating and running a patch job.
Example
package
main
import
(
"context"
osconfig
"cloud.google.com/go/osconfig/apiv1beta"
osconfigpb
"cloud.google.com/go/osconfig/apiv1beta/osconfigpb"
)
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
:=
osconfig
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& osconfigpb
.
ExecutePatchJobRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/osconfig/apiv1beta/osconfigpb#ExecutePatchJobRequest.
}
resp
,
err
:=
c
.
ExecutePatchJob
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetGuestPolicy
func
(
c
*
Client
)
GetGuestPolicy
(
ctx
context
.
Context
,
req
*
osconfigpb
.
GetGuestPolicyRequest
,
opts
...
gax
.
CallOption
)
(
*
osconfigpb
.
GuestPolicy
,
error
)
GetGuestPolicy get an OS Config guest policy.
Example
package
main
import
(
"context"
osconfig
"cloud.google.com/go/osconfig/apiv1beta"
osconfigpb
"cloud.google.com/go/osconfig/apiv1beta/osconfigpb"
)
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
:=
osconfig
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& osconfigpb
.
GetGuestPolicyRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/osconfig/apiv1beta/osconfigpb#GetGuestPolicyRequest.
}
resp
,
err
:=
c
.
GetGuestPolicy
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetPatchDeployment
func
(
c
*
Client
)
GetPatchDeployment
(
ctx
context
.
Context
,
req
*
osconfigpb
.
GetPatchDeploymentRequest
,
opts
...
gax
.
CallOption
)
(
*
osconfigpb
.
PatchDeployment
,
error
)
GetPatchDeployment get an OS Config patch deployment.
Example
package
main
import
(
"context"
osconfig
"cloud.google.com/go/osconfig/apiv1beta"
osconfigpb
"cloud.google.com/go/osconfig/apiv1beta/osconfigpb"
)
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
:=
osconfig
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& osconfigpb
.
GetPatchDeploymentRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/osconfig/apiv1beta/osconfigpb#GetPatchDeploymentRequest.
}
resp
,
err
:=
c
.
GetPatchDeployment
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetPatchJob
func
(
c
*
Client
)
GetPatchJob
(
ctx
context
.
Context
,
req
*
osconfigpb
.
GetPatchJobRequest
,
opts
...
gax
.
CallOption
)
(
*
osconfigpb
.
PatchJob
,
error
)
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
"cloud.google.com/go/osconfig/apiv1beta/osconfigpb"
)
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
:=
osconfig
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& osconfigpb
.
GetPatchJobRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/osconfig/apiv1beta/osconfigpb#GetPatchJobRequest.
}
resp
,
err
:=
c
.
GetPatchJob
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) ListGuestPolicies
func
(
c
*
Client
)
ListGuestPolicies
(
ctx
context
.
Context
,
req
*
osconfigpb
.
ListGuestPoliciesRequest
,
opts
...
gax
.
CallOption
)
*
GuestPolicyIterator
ListGuestPolicies get a page of OS Config guest policies.
Examples
package
main
import
(
"context"
osconfig
"cloud.google.com/go/osconfig/apiv1beta"
osconfigpb
"cloud.google.com/go/osconfig/apiv1beta/osconfigpb"
"google.golang.org/api/iterator"
)
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
:=
osconfig
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& osconfigpb
.
ListGuestPoliciesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/osconfig/apiv1beta/osconfigpb#ListGuestPoliciesRequest.
}
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
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
osconfigpb
.
ListGuestPoliciesResponse
)
}
}
all
package
main
import
(
"context"
osconfig
"cloud.google.com/go/osconfig/apiv1beta"
osconfigpb
"cloud.google.com/go/osconfig/apiv1beta/osconfigpb"
)
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
:=
osconfig
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& osconfigpb
.
ListGuestPoliciesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/osconfig/apiv1beta/osconfigpb#ListGuestPoliciesRequest.
}
for
resp
,
err
:=
range
c
.
ListGuestPolicies
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) ListPatchDeployments
func
(
c
*
Client
)
ListPatchDeployments
(
ctx
context
.
Context
,
req
*
osconfigpb
.
ListPatchDeploymentsRequest
,
opts
...
gax
.
CallOption
)
*
PatchDeploymentIterator
ListPatchDeployments get a page of OS Config patch deployments.
Examples
package
main
import
(
"context"
osconfig
"cloud.google.com/go/osconfig/apiv1beta"
osconfigpb
"cloud.google.com/go/osconfig/apiv1beta/osconfigpb"
"google.golang.org/api/iterator"
)
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
:=
osconfig
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& osconfigpb
.
ListPatchDeploymentsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/osconfig/apiv1beta/osconfigpb#ListPatchDeploymentsRequest.
}
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
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
osconfigpb
.
ListPatchDeploymentsResponse
)
}
}
all
package
main
import
(
"context"
osconfig
"cloud.google.com/go/osconfig/apiv1beta"
osconfigpb
"cloud.google.com/go/osconfig/apiv1beta/osconfigpb"
)
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
:=
osconfig
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& osconfigpb
.
ListPatchDeploymentsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/osconfig/apiv1beta/osconfigpb#ListPatchDeploymentsRequest.
}
for
resp
,
err
:=
range
c
.
ListPatchDeployments
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) ListPatchJobInstanceDetails
func
(
c
*
Client
)
ListPatchJobInstanceDetails
(
ctx
context
.
Context
,
req
*
osconfigpb
.
ListPatchJobInstanceDetailsRequest
,
opts
...
gax
.
CallOption
)
*
PatchJobInstanceDetailsIterator
ListPatchJobInstanceDetails get a list of instance details for a given patch job.
Examples
package
main
import
(
"context"
osconfig
"cloud.google.com/go/osconfig/apiv1beta"
osconfigpb
"cloud.google.com/go/osconfig/apiv1beta/osconfigpb"
"google.golang.org/api/iterator"
)
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
:=
osconfig
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& osconfigpb
.
ListPatchJobInstanceDetailsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/osconfig/apiv1beta/osconfigpb#ListPatchJobInstanceDetailsRequest.
}
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
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
osconfigpb
.
ListPatchJobInstanceDetailsResponse
)
}
}
all
package
main
import
(
"context"
osconfig
"cloud.google.com/go/osconfig/apiv1beta"
osconfigpb
"cloud.google.com/go/osconfig/apiv1beta/osconfigpb"
)
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
:=
osconfig
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& osconfigpb
.
ListPatchJobInstanceDetailsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/osconfig/apiv1beta/osconfigpb#ListPatchJobInstanceDetailsRequest.
}
for
resp
,
err
:=
range
c
.
ListPatchJobInstanceDetails
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) ListPatchJobs
func
(
c
*
Client
)
ListPatchJobs
(
ctx
context
.
Context
,
req
*
osconfigpb
.
ListPatchJobsRequest
,
opts
...
gax
.
CallOption
)
*
PatchJobIterator
ListPatchJobs get a list of patch jobs.
Examples
package
main
import
(
"context"
osconfig
"cloud.google.com/go/osconfig/apiv1beta"
osconfigpb
"cloud.google.com/go/osconfig/apiv1beta/osconfigpb"
"google.golang.org/api/iterator"
)
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
:=
osconfig
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& osconfigpb
.
ListPatchJobsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/osconfig/apiv1beta/osconfigpb#ListPatchJobsRequest.
}
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
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
osconfigpb
.
ListPatchJobsResponse
)
}
}
all
package
main
import
(
"context"
osconfig
"cloud.google.com/go/osconfig/apiv1beta"
osconfigpb
"cloud.google.com/go/osconfig/apiv1beta/osconfigpb"
)
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
:=
osconfig
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& osconfigpb
.
ListPatchJobsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/osconfig/apiv1beta/osconfigpb#ListPatchJobsRequest.
}
for
resp
,
err
:=
range
c
.
ListPatchJobs
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) LookupEffectiveGuestPolicy
func
(
c
*
Client
)
LookupEffectiveGuestPolicy
(
ctx
context
.
Context
,
req
*
osconfigpb
.
LookupEffectiveGuestPolicyRequest
,
opts
...
gax
.
CallOption
)
(
*
osconfigpb
.
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"
osconfig
"cloud.google.com/go/osconfig/apiv1beta"
osconfigpb
"cloud.google.com/go/osconfig/apiv1beta/osconfigpb"
)
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
:=
osconfig
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& osconfigpb
.
LookupEffectiveGuestPolicyRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/osconfig/apiv1beta/osconfigpb#LookupEffectiveGuestPolicyRequest.
}
resp
,
err
:=
c
.
LookupEffectiveGuestPolicy
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) PausePatchDeployment
func
(
c
*
Client
)
PausePatchDeployment
(
ctx
context
.
Context
,
req
*
osconfigpb
.
PausePatchDeploymentRequest
,
opts
...
gax
.
CallOption
)
(
*
osconfigpb
.
PatchDeployment
,
error
)
PausePatchDeployment change state of patch deployment to “PAUSED”. Patch deployment in paused state doesn’t generate patch jobs.
Example
package
main
import
(
"context"
osconfig
"cloud.google.com/go/osconfig/apiv1beta"
osconfigpb
"cloud.google.com/go/osconfig/apiv1beta/osconfigpb"
)
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
:=
osconfig
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& osconfigpb
.
PausePatchDeploymentRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/osconfig/apiv1beta/osconfigpb#PausePatchDeploymentRequest.
}
resp
,
err
:=
c
.
PausePatchDeployment
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) ResumePatchDeployment
func
(
c
*
Client
)
ResumePatchDeployment
(
ctx
context
.
Context
,
req
*
osconfigpb
.
ResumePatchDeploymentRequest
,
opts
...
gax
.
CallOption
)
(
*
osconfigpb
.
PatchDeployment
,
error
)
ResumePatchDeployment change state of patch deployment back to “ACTIVE”. Patch deployment in active state continues to generate patch jobs.
Example
package
main
import
(
"context"
osconfig
"cloud.google.com/go/osconfig/apiv1beta"
osconfigpb
"cloud.google.com/go/osconfig/apiv1beta/osconfigpb"
)
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
:=
osconfig
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& osconfigpb
.
ResumePatchDeploymentRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/osconfig/apiv1beta/osconfigpb#ResumePatchDeploymentRequest.
}
resp
,
err
:=
c
.
ResumePatchDeployment
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) UpdateGuestPolicy
func
(
c
*
Client
)
UpdateGuestPolicy
(
ctx
context
.
Context
,
req
*
osconfigpb
.
UpdateGuestPolicyRequest
,
opts
...
gax
.
CallOption
)
(
*
osconfigpb
.
GuestPolicy
,
error
)
UpdateGuestPolicy update an OS Config guest policy.
Example
package
main
import
(
"context"
osconfig
"cloud.google.com/go/osconfig/apiv1beta"
osconfigpb
"cloud.google.com/go/osconfig/apiv1beta/osconfigpb"
)
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
:=
osconfig
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& osconfigpb
.
UpdateGuestPolicyRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/osconfig/apiv1beta/osconfigpb#UpdateGuestPolicyRequest.
}
resp
,
err
:=
c
.
UpdateGuestPolicy
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) UpdatePatchDeployment
func
(
c
*
Client
)
UpdatePatchDeployment
(
ctx
context
.
Context
,
req
*
osconfigpb
.
UpdatePatchDeploymentRequest
,
opts
...
gax
.
CallOption
)
(
*
osconfigpb
.
PatchDeployment
,
error
)
UpdatePatchDeployment update an OS Config patch deployment.
Example
package
main
import
(
"context"
osconfig
"cloud.google.com/go/osconfig/apiv1beta"
osconfigpb
"cloud.google.com/go/osconfig/apiv1beta/osconfigpb"
)
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
:=
osconfig
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& osconfigpb
.
UpdatePatchDeploymentRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/osconfig/apiv1beta/osconfigpb#UpdatePatchDeploymentRequest.
}
resp
,
err
:=
c
.
UpdatePatchDeployment
(
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) All
func
(
it
*
GuestPolicyIterator
)
All
()
iter
.
Seq2
[
*
osconfigpb
.
GuestPolicy
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*GuestPolicyIterator) Next
func
(
it
*
GuestPolicyIterator
)
Next
()
(
*
osconfigpb
.
GuestPolicy
,
error
)
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) All
func
(
it
*
PatchDeploymentIterator
)
All
()
iter
.
Seq2
[
*
osconfigpb
.
PatchDeployment
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*PatchDeploymentIterator) Next
func
(
it
*
PatchDeploymentIterator
)
Next
()
(
*
osconfigpb
.
PatchDeployment
,
error
)
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
func
(
it
*
PatchDeploymentIterator
)
PageInfo
()
*
iterator
.
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) All
func
(
it
*
PatchJobInstanceDetailsIterator
)
All
()
iter
.
Seq2
[
*
osconfigpb
.
PatchJobInstanceDetails
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*PatchJobInstanceDetailsIterator) Next
func
(
it
*
PatchJobInstanceDetailsIterator
)
Next
()
(
*
osconfigpb
.
PatchJobInstanceDetails
,
error
)
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
func
(
it
*
PatchJobInstanceDetailsIterator
)
PageInfo
()
*
iterator
.
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) All
func
(
it
*
PatchJobIterator
)
All
()
iter
.
Seq2
[
*
osconfigpb
.
PatchJob
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*PatchJobIterator) Next
func
(
it
*
PatchJobIterator
)
Next
()
(
*
osconfigpb
.
PatchJob
,
error
)
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.
