Documentation ¶
Index ¶
- func DefaultAuthScopes() []string
- type CallOptions
- type Client
- func (c *Client) CancelPatchJob(ctx context.Context, req *osconfigpb.CancelPatchJobRequest, ...) (*osconfigpb.PatchJob, error)
- func (c *Client) Close() error
- func (c *Client) Connection() *grpc.ClientConn
- func (c *Client) CreateGuestPolicy(ctx context.Context, req *osconfigpb.CreateGuestPolicyRequest, ...) (*osconfigpb.GuestPolicy, error)
- func (c *Client) CreatePatchDeployment(ctx context.Context, req *osconfigpb.CreatePatchDeploymentRequest, ...) (*osconfigpb.PatchDeployment, error)
- func (c *Client) DeleteGuestPolicy(ctx context.Context, req *osconfigpb.DeleteGuestPolicyRequest, ...) error
- func (c *Client) DeletePatchDeployment(ctx context.Context, req *osconfigpb.DeletePatchDeploymentRequest, ...) error
- func (c *Client) ExecutePatchJob(ctx context.Context, req *osconfigpb.ExecutePatchJobRequest, ...) (*osconfigpb.PatchJob, error)
- func (c *Client) GetGuestPolicy(ctx context.Context, req *osconfigpb.GetGuestPolicyRequest, ...) (*osconfigpb.GuestPolicy, error)
- func (c *Client) GetPatchDeployment(ctx context.Context, req *osconfigpb.GetPatchDeploymentRequest, ...) (*osconfigpb.PatchDeployment, error)
- func (c *Client) GetPatchJob(ctx context.Context, req *osconfigpb.GetPatchJobRequest, ...) (*osconfigpb.PatchJob, error)
- func (c *Client) ListGuestPolicies(ctx context.Context, req *osconfigpb.ListGuestPoliciesRequest, ...) *GuestPolicyIterator
- func (c *Client) ListPatchDeployments(ctx context.Context, req *osconfigpb.ListPatchDeploymentsRequest, ...) *PatchDeploymentIterator
- func (c *Client) ListPatchJobInstanceDetails(ctx context.Context, req *osconfigpb.ListPatchJobInstanceDetailsRequest, ...) *PatchJobInstanceDetailsIterator
- func (c *Client) ListPatchJobs(ctx context.Context, req *osconfigpb.ListPatchJobsRequest, ...) *PatchJobIterator
- func (c *Client) LookupEffectiveGuestPolicy(ctx context.Context, req *osconfigpb.LookupEffectiveGuestPolicyRequest, ...) (*osconfigpb.EffectiveGuestPolicy, error)
- func (c *Client) UpdateGuestPolicy(ctx context.Context, req *osconfigpb.UpdateGuestPolicyRequest, ...) (*osconfigpb.GuestPolicy, error)
- type GuestPolicyIterator
- type PatchDeploymentIterator
- type PatchJobInstanceDetailsIterator
- type PatchJobIterator
Examples ¶
- Client.CancelPatchJob
- Client.CreateGuestPolicy
- Client.CreatePatchDeployment
- Client.DeleteGuestPolicy
- Client.DeletePatchDeployment
- Client.ExecutePatchJob
- Client.GetGuestPolicy
- Client.GetPatchDeployment
- Client.GetPatchJob
- Client.ListGuestPolicies
- Client.ListPatchDeployments
- Client.ListPatchJobInstanceDetails
- Client.ListPatchJobs
- Client.LookupEffectiveGuestPolicy
- Client.UpdateGuestPolicy
- NewClient
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 { 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.
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 ¶
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 }
Output:
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 "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 }
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 ¶
func (c *Client) Connection() *grpc.ClientConn
Connection returns the client's connection to the API service.
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 "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 }
Output:
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 "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 }
Output:
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 "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. } }
Output:
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 "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. } }
Output:
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 "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 }
Output:
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 "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 }
Output:
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 "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 }
Output:
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 "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 }
Output:
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.
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 } }
Output:
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.
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 } }
Output:
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.
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 } }
Output:
func (*Client) ListPatchJobs ¶
func (c *Client) ListPatchJobs(ctx context.Context, req *osconfigpb.ListPatchJobsRequest, opts ...gax.CallOption) *PatchJobIterator
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 } }
Output:
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 "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 }
Output:
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 "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 }
Output:
type 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 ¶
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.
type 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 ¶
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.
type 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 ¶
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.
type 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 ¶
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.