Documentation ¶
Overview ¶
Package securityposture is an auto-generated package for the Security Posture API.
Security Posture is a comprehensive framework of policy sets that empowers organizations to define, assess early, deploy, and monitor their security measures in a unified way and helps simplify governance and reduces administrative toil.
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/securityposture/apiv1@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 := securityposture.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 := &securityposturepb.CreatePostureRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/securityposture/apiv1/securityposturepb#CreatePostureRequest. } op, err := c.CreatePosture(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) 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.
Index ¶
- func DefaultAuthScopes() []string
- type CallOptions
- type Client
- func (c *Client) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, ...) error
- func (c *Client) Close() error
- func (c *Client) Connection() *grpc.ClientConndeprecated
- func (c *Client) CreatePosture(ctx context.Context, req *securityposturepb.CreatePostureRequest, ...) (*CreatePostureOperation, error)
- func (c *Client) CreatePostureDeployment(ctx context.Context, req *securityposturepb.CreatePostureDeploymentRequest, ...) (*CreatePostureDeploymentOperation, error)
- func (c *Client) CreatePostureDeploymentOperation(name string) *CreatePostureDeploymentOperation
- func (c *Client) CreatePostureOperation(name string) *CreatePostureOperation
- func (c *Client) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, ...) error
- func (c *Client) DeletePosture(ctx context.Context, req *securityposturepb.DeletePostureRequest, ...) (*DeletePostureOperation, error)
- func (c *Client) DeletePostureDeployment(ctx context.Context, req *securityposturepb.DeletePostureDeploymentRequest, ...) (*DeletePostureDeploymentOperation, error)
- func (c *Client) DeletePostureDeploymentOperation(name string) *DeletePostureDeploymentOperation
- func (c *Client) DeletePostureOperation(name string) *DeletePostureOperation
- func (c *Client) ExtractPosture(ctx context.Context, req *securityposturepb.ExtractPostureRequest, ...) (*ExtractPostureOperation, error)
- func (c *Client) ExtractPostureOperation(name string) *ExtractPostureOperation
- func (c *Client) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, ...) (*locationpb.Location, error)
- func (c *Client) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, ...) (*longrunningpb.Operation, error)
- func (c *Client) GetPosture(ctx context.Context, req *securityposturepb.GetPostureRequest, ...) (*securityposturepb.Posture, error)
- func (c *Client) GetPostureDeployment(ctx context.Context, req *securityposturepb.GetPostureDeploymentRequest, ...) (*securityposturepb.PostureDeployment, error)
- func (c *Client) GetPostureTemplate(ctx context.Context, req *securityposturepb.GetPostureTemplateRequest, ...) (*securityposturepb.PostureTemplate, error)
- func (c *Client) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, ...) *LocationIterator
- func (c *Client) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, ...) *OperationIterator
- func (c *Client) ListPostureDeployments(ctx context.Context, req *securityposturepb.ListPostureDeploymentsRequest, ...) *PostureDeploymentIterator
- func (c *Client) ListPostureRevisions(ctx context.Context, req *securityposturepb.ListPostureRevisionsRequest, ...) *PostureIterator
- func (c *Client) ListPostureTemplates(ctx context.Context, req *securityposturepb.ListPostureTemplatesRequest, ...) *PostureTemplateIterator
- func (c *Client) ListPostures(ctx context.Context, req *securityposturepb.ListPosturesRequest, ...) *PostureIterator
- func (c *Client) UpdatePosture(ctx context.Context, req *securityposturepb.UpdatePostureRequest, ...) (*UpdatePostureOperation, error)
- func (c *Client) UpdatePostureDeployment(ctx context.Context, req *securityposturepb.UpdatePostureDeploymentRequest, ...) (*UpdatePostureDeploymentOperation, error)
- func (c *Client) UpdatePostureDeploymentOperation(name string) *UpdatePostureDeploymentOperation
- func (c *Client) UpdatePostureOperation(name string) *UpdatePostureOperation
- type CreatePostureDeploymentOperation
- func (op *CreatePostureDeploymentOperation) Done() bool
- func (op *CreatePostureDeploymentOperation) Metadata() (*securityposturepb.OperationMetadata, error)
- func (op *CreatePostureDeploymentOperation) Name() string
- func (op *CreatePostureDeploymentOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*securityposturepb.PostureDeployment, error)
- func (op *CreatePostureDeploymentOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*securityposturepb.PostureDeployment, error)
- type CreatePostureOperation
- func (op *CreatePostureOperation) Done() bool
- func (op *CreatePostureOperation) Metadata() (*securityposturepb.OperationMetadata, error)
- func (op *CreatePostureOperation) Name() string
- func (op *CreatePostureOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*securityposturepb.Posture, error)
- func (op *CreatePostureOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*securityposturepb.Posture, error)
- type DeletePostureDeploymentOperation
- func (op *DeletePostureDeploymentOperation) Done() bool
- func (op *DeletePostureDeploymentOperation) Metadata() (*securityposturepb.OperationMetadata, error)
- func (op *DeletePostureDeploymentOperation) Name() string
- func (op *DeletePostureDeploymentOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeletePostureDeploymentOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeletePostureOperation
- func (op *DeletePostureOperation) Done() bool
- func (op *DeletePostureOperation) Metadata() (*securityposturepb.OperationMetadata, error)
- func (op *DeletePostureOperation) Name() string
- func (op *DeletePostureOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeletePostureOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type ExtractPostureOperation
- func (op *ExtractPostureOperation) Done() bool
- func (op *ExtractPostureOperation) Metadata() (*securityposturepb.OperationMetadata, error)
- func (op *ExtractPostureOperation) Name() string
- func (op *ExtractPostureOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*securityposturepb.Posture, error)
- func (op *ExtractPostureOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*securityposturepb.Posture, error)
- type LocationIterator
- type OperationIterator
- type PostureDeploymentIterator
- type PostureIterator
- type PostureTemplateIterator
- type UpdatePostureDeploymentOperation
- func (op *UpdatePostureDeploymentOperation) Done() bool
- func (op *UpdatePostureDeploymentOperation) Metadata() (*securityposturepb.OperationMetadata, error)
- func (op *UpdatePostureDeploymentOperation) Name() string
- func (op *UpdatePostureDeploymentOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*securityposturepb.PostureDeployment, error)
- func (op *UpdatePostureDeploymentOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*securityposturepb.PostureDeployment, error)
- type UpdatePostureOperation
- func (op *UpdatePostureOperation) Done() bool
- func (op *UpdatePostureOperation) Metadata() (*securityposturepb.OperationMetadata, error)
- func (op *UpdatePostureOperation) Name() string
- func (op *UpdatePostureOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*securityposturepb.Posture, error)
- func (op *UpdatePostureOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*securityposturepb.Posture, error)
Examples ¶
- Client.CancelOperation
- Client.CreatePosture
- Client.CreatePostureDeployment
- Client.DeleteOperation
- Client.DeletePosture
- Client.DeletePostureDeployment
- Client.ExtractPosture
- Client.GetLocation
- Client.GetOperation
- Client.GetPosture
- Client.GetPostureDeployment
- Client.GetPostureTemplate
- Client.ListLocations
- Client.ListLocations (All)
- Client.ListOperations
- Client.ListOperations (All)
- Client.ListPostureDeployments
- Client.ListPostureDeployments (All)
- Client.ListPostureRevisions
- Client.ListPostureRevisions (All)
- Client.ListPostureTemplates
- Client.ListPostureTemplates (All)
- Client.ListPostures
- Client.ListPostures (All)
- Client.UpdatePosture
- Client.UpdatePostureDeployment
- NewClient
- NewRESTClient
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 { ListPostures []gax.CallOption ListPostureRevisions []gax.CallOption GetPosture []gax.CallOption CreatePosture []gax.CallOption UpdatePosture []gax.CallOption DeletePosture []gax.CallOption ExtractPosture []gax.CallOption ListPostureDeployments []gax.CallOption GetPostureDeployment []gax.CallOption CreatePostureDeployment []gax.CallOption UpdatePostureDeployment []gax.CallOption DeletePostureDeployment []gax.CallOption ListPostureTemplates []gax.CallOption GetPostureTemplate []gax.CallOption GetLocation []gax.CallOption ListLocations []gax.CallOption CancelOperation []gax.CallOption DeleteOperation []gax.CallOption GetOperation []gax.CallOption ListOperations []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 // LROClient is used internally to handle long-running operations. // It is exposed so that its CallOptions can be modified if required. // Users should not Close this client. LROClient *lroauto.OperationsClient // contains filtered or unexported fields }
Client is a client for interacting with Security Posture API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
Service describing handlers for resources.
func NewClient ¶
NewClient creates a new security posture client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
Service describing handlers for resources.
Example ¶
package main import ( "context" securityposture "cloud.google.com/go/securityposture/apiv1" ) 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 := securityposture.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() // TODO: Use client. _ = c }
Output:
func NewRESTClient ¶
NewRESTClient creates a new security posture rest client.
Service describing handlers for resources.
Example ¶
package main import ( "context" securityposture "cloud.google.com/go/securityposture/apiv1" ) 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 := securityposture.NewRESTClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() // TODO: Use client. _ = c }
Output:
func (*Client) CancelOperation ¶
func (c *Client) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, opts ...gax.CallOption) error
CancelOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" securityposture "cloud.google.com/go/securityposture/apiv1" ) 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 := securityposture.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.CancelOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#CancelOperationRequest. } err = c.CancelOperation(ctx, req) if err != nil { // TODO: Handle error. } }
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
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) CreatePosture ¶
func (c *Client) CreatePosture(ctx context.Context, req *securityposturepb.CreatePostureRequest, opts ...gax.CallOption) (*CreatePostureOperation, error)
CreatePosture creates a new Posture resource. If a Posture with the specified name already exists in the specified organization and location, the long running operation returns a ALREADY_EXISTS error.
Example ¶
package main import ( "context" securityposture "cloud.google.com/go/securityposture/apiv1" securityposturepb "cloud.google.com/go/securityposture/apiv1/securityposturepb" ) 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 := securityposture.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &securityposturepb.CreatePostureRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/securityposture/apiv1/securityposturepb#CreatePostureRequest. } op, err := c.CreatePosture(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) CreatePostureDeployment ¶
func (c *Client) CreatePostureDeployment(ctx context.Context, req *securityposturepb.CreatePostureDeploymentRequest, opts ...gax.CallOption) (*CreatePostureDeploymentOperation, error)
CreatePostureDeployment creates a new PostureDeployment in a given project and location.
Example ¶
package main import ( "context" securityposture "cloud.google.com/go/securityposture/apiv1" securityposturepb "cloud.google.com/go/securityposture/apiv1/securityposturepb" ) 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 := securityposture.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &securityposturepb.CreatePostureDeploymentRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/securityposture/apiv1/securityposturepb#CreatePostureDeploymentRequest. } op, err := c.CreatePostureDeployment(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) CreatePostureDeploymentOperation ¶
func (c *Client) CreatePostureDeploymentOperation(name string) *CreatePostureDeploymentOperation
CreatePostureDeploymentOperation returns a new CreatePostureDeploymentOperation from a given name. The name must be that of a previously created CreatePostureDeploymentOperation, possibly from a different process.
func (*Client) CreatePostureOperation ¶
func (c *Client) CreatePostureOperation(name string) *CreatePostureOperation
CreatePostureOperation returns a new CreatePostureOperation from a given name. The name must be that of a previously created CreatePostureOperation, possibly from a different process.
func (*Client) DeleteOperation ¶
func (c *Client) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, opts ...gax.CallOption) error
DeleteOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" securityposture "cloud.google.com/go/securityposture/apiv1" ) 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 := securityposture.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.DeleteOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#DeleteOperationRequest. } err = c.DeleteOperation(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*Client) DeletePosture ¶
func (c *Client) DeletePosture(ctx context.Context, req *securityposturepb.DeletePostureRequest, opts ...gax.CallOption) (*DeletePostureOperation, error)
DeletePosture deletes all the revisions of a resource. A posture can only be deleted when none of the revisions are deployed to any workload.
Example ¶
package main import ( "context" securityposture "cloud.google.com/go/securityposture/apiv1" securityposturepb "cloud.google.com/go/securityposture/apiv1/securityposturepb" ) 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 := securityposture.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &securityposturepb.DeletePostureRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/securityposture/apiv1/securityposturepb#DeletePostureRequest. } op, err := c.DeletePosture(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
Output:
func (*Client) DeletePostureDeployment ¶
func (c *Client) DeletePostureDeployment(ctx context.Context, req *securityposturepb.DeletePostureDeploymentRequest, opts ...gax.CallOption) (*DeletePostureDeploymentOperation, error)
DeletePostureDeployment deletes a single PostureDeployment.
Example ¶
package main import ( "context" securityposture "cloud.google.com/go/securityposture/apiv1" securityposturepb "cloud.google.com/go/securityposture/apiv1/securityposturepb" ) 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 := securityposture.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &securityposturepb.DeletePostureDeploymentRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/securityposture/apiv1/securityposturepb#DeletePostureDeploymentRequest. } op, err := c.DeletePostureDeployment(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
Output:
func (*Client) DeletePostureDeploymentOperation ¶
func (c *Client) DeletePostureDeploymentOperation(name string) *DeletePostureDeploymentOperation
DeletePostureDeploymentOperation returns a new DeletePostureDeploymentOperation from a given name. The name must be that of a previously created DeletePostureDeploymentOperation, possibly from a different process.
func (*Client) DeletePostureOperation ¶
func (c *Client) DeletePostureOperation(name string) *DeletePostureOperation
DeletePostureOperation returns a new DeletePostureOperation from a given name. The name must be that of a previously created DeletePostureOperation, possibly from a different process.
func (*Client) ExtractPosture ¶
func (c *Client) ExtractPosture(ctx context.Context, req *securityposturepb.ExtractPostureRequest, opts ...gax.CallOption) (*ExtractPostureOperation, error)
ExtractPosture extracts existing policies on a workload as a posture. If a Posture on the given workload already exists, the long running operation returns a ALREADY_EXISTS error.
Example ¶
package main import ( "context" securityposture "cloud.google.com/go/securityposture/apiv1" securityposturepb "cloud.google.com/go/securityposture/apiv1/securityposturepb" ) 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 := securityposture.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &securityposturepb.ExtractPostureRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/securityposture/apiv1/securityposturepb#ExtractPostureRequest. } op, err := c.ExtractPosture(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) ExtractPostureOperation ¶
func (c *Client) ExtractPostureOperation(name string) *ExtractPostureOperation
ExtractPostureOperation returns a new ExtractPostureOperation from a given name. The name must be that of a previously created ExtractPostureOperation, possibly from a different process.
func (*Client) GetLocation ¶
func (c *Client) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, opts ...gax.CallOption) (*locationpb.Location, error)
GetLocation gets information about a location.
Example ¶
package main import ( "context" securityposture "cloud.google.com/go/securityposture/apiv1" locationpb "google.golang.org/genproto/googleapis/cloud/location" ) 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 := securityposture.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &locationpb.GetLocationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#GetLocationRequest. } resp, err := c.GetLocation(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) GetOperation ¶
func (c *Client) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)
GetOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" securityposture "cloud.google.com/go/securityposture/apiv1" ) 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 := securityposture.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.GetOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest. } resp, err := c.GetOperation(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) GetPosture ¶
func (c *Client) GetPosture(ctx context.Context, req *securityposturepb.GetPostureRequest, opts ...gax.CallOption) (*securityposturepb.Posture, error)
GetPosture gets a posture in a given organization and location. User must provide revision_id to retrieve a specific revision of the resource. NOT_FOUND error is returned if the revision_id or the Posture name does not exist. In case revision_id is not provided then the latest Posture revision by UpdateTime is returned.
Example ¶
package main import ( "context" securityposture "cloud.google.com/go/securityposture/apiv1" securityposturepb "cloud.google.com/go/securityposture/apiv1/securityposturepb" ) 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 := securityposture.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &securityposturepb.GetPostureRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/securityposture/apiv1/securityposturepb#GetPostureRequest. } resp, err := c.GetPosture(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) GetPostureDeployment ¶
func (c *Client) GetPostureDeployment(ctx context.Context, req *securityposturepb.GetPostureDeploymentRequest, opts ...gax.CallOption) (*securityposturepb.PostureDeployment, error)
GetPostureDeployment gets details of a single PostureDeployment.
Example ¶
package main import ( "context" securityposture "cloud.google.com/go/securityposture/apiv1" securityposturepb "cloud.google.com/go/securityposture/apiv1/securityposturepb" ) 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 := securityposture.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &securityposturepb.GetPostureDeploymentRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/securityposture/apiv1/securityposturepb#GetPostureDeploymentRequest. } resp, err := c.GetPostureDeployment(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) GetPostureTemplate ¶
func (c *Client) GetPostureTemplate(ctx context.Context, req *securityposturepb.GetPostureTemplateRequest, opts ...gax.CallOption) (*securityposturepb.PostureTemplate, error)
GetPostureTemplate gets a PostureTemplate. User must provide revision_id to retrieve a specific revision of the resource. NOT_FOUND error is returned if the revision_id or the PostureTemplate name does not exist. In case revision_id is not provided then the PostureTemplate with latest revision_id is returned.
Example ¶
package main import ( "context" securityposture "cloud.google.com/go/securityposture/apiv1" securityposturepb "cloud.google.com/go/securityposture/apiv1/securityposturepb" ) 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 := securityposture.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &securityposturepb.GetPostureTemplateRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/securityposture/apiv1/securityposturepb#GetPostureTemplateRequest. } resp, err := c.GetPostureTemplate(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) ListLocations ¶
func (c *Client) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, opts ...gax.CallOption) *LocationIterator
ListLocations lists information about the supported locations for this service.
Example ¶
package main import ( "context" securityposture "cloud.google.com/go/securityposture/apiv1" "google.golang.org/api/iterator" locationpb "google.golang.org/genproto/googleapis/cloud/location" ) 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 := securityposture.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &locationpb.ListLocationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest. } it := c.ListLocations(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.(*locationpb.ListLocationsResponse) } }
Output:
Example (All) ¶
package main import ( "context" securityposture "cloud.google.com/go/securityposture/apiv1" locationpb "google.golang.org/genproto/googleapis/cloud/location" ) 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 := securityposture.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &locationpb.ListLocationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest. } for resp, err := range c.ListLocations(ctx, req).All() { if err != nil { // TODO: Handle error and break/return/continue. Iteration will stop after any error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) ListOperations ¶
func (c *Client) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator
ListOperations is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" securityposture "cloud.google.com/go/securityposture/apiv1" "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 := securityposture.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.ListOperationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest. } it := c.ListOperations(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.(*longrunningpb.ListOperationsResponse) } }
Output:
Example (All) ¶
package main import ( "context" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" securityposture "cloud.google.com/go/securityposture/apiv1" ) 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 := securityposture.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.ListOperationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest. } for resp, err := range c.ListOperations(ctx, req).All() { if err != nil { // TODO: Handle error and break/return/continue. Iteration will stop after any error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) ListPostureDeployments ¶
func (c *Client) ListPostureDeployments(ctx context.Context, req *securityposturepb.ListPostureDeploymentsRequest, opts ...gax.CallOption) *PostureDeploymentIterator
ListPostureDeployments postureDeployments Lists PostureDeployments in a given project and location.
Example ¶
package main import ( "context" securityposture "cloud.google.com/go/securityposture/apiv1" securityposturepb "cloud.google.com/go/securityposture/apiv1/securityposturepb" "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 := securityposture.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &securityposturepb.ListPostureDeploymentsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/securityposture/apiv1/securityposturepb#ListPostureDeploymentsRequest. } it := c.ListPostureDeployments(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.(*securityposturepb.ListPostureDeploymentsResponse) } }
Output:
Example (All) ¶
package main import ( "context" securityposture "cloud.google.com/go/securityposture/apiv1" securityposturepb "cloud.google.com/go/securityposture/apiv1/securityposturepb" ) 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 := securityposture.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &securityposturepb.ListPostureDeploymentsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/securityposture/apiv1/securityposturepb#ListPostureDeploymentsRequest. } for resp, err := range c.ListPostureDeployments(ctx, req).All() { if err != nil { // TODO: Handle error and break/return/continue. Iteration will stop after any error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) ListPostureRevisions ¶
func (c *Client) ListPostureRevisions(ctx context.Context, req *securityposturepb.ListPostureRevisionsRequest, opts ...gax.CallOption) *PostureIterator
ListPostureRevisions lists revisions of a Posture in a given organization and location.
Example ¶
package main import ( "context" securityposture "cloud.google.com/go/securityposture/apiv1" securityposturepb "cloud.google.com/go/securityposture/apiv1/securityposturepb" "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 := securityposture.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &securityposturepb.ListPostureRevisionsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/securityposture/apiv1/securityposturepb#ListPostureRevisionsRequest. } it := c.ListPostureRevisions(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.(*securityposturepb.ListPostureRevisionsResponse) } }
Output:
Example (All) ¶
package main import ( "context" securityposture "cloud.google.com/go/securityposture/apiv1" securityposturepb "cloud.google.com/go/securityposture/apiv1/securityposturepb" ) 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 := securityposture.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &securityposturepb.ListPostureRevisionsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/securityposture/apiv1/securityposturepb#ListPostureRevisionsRequest. } for resp, err := range c.ListPostureRevisions(ctx, req).All() { if err != nil { // TODO: Handle error and break/return/continue. Iteration will stop after any error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) ListPostureTemplates ¶
func (c *Client) ListPostureTemplates(ctx context.Context, req *securityposturepb.ListPostureTemplatesRequest, opts ...gax.CallOption) *PostureTemplateIterator
ListPostureTemplates postureTemplates Lists all the PostureTemplates available to the user.
Example ¶
package main import ( "context" securityposture "cloud.google.com/go/securityposture/apiv1" securityposturepb "cloud.google.com/go/securityposture/apiv1/securityposturepb" "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 := securityposture.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &securityposturepb.ListPostureTemplatesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/securityposture/apiv1/securityposturepb#ListPostureTemplatesRequest. } it := c.ListPostureTemplates(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.(*securityposturepb.ListPostureTemplatesResponse) } }
Output:
Example (All) ¶
package main import ( "context" securityposture "cloud.google.com/go/securityposture/apiv1" securityposturepb "cloud.google.com/go/securityposture/apiv1/securityposturepb" ) 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 := securityposture.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &securityposturepb.ListPostureTemplatesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/securityposture/apiv1/securityposturepb#ListPostureTemplatesRequest. } for resp, err := range c.ListPostureTemplates(ctx, req).All() { if err != nil { // TODO: Handle error and break/return/continue. Iteration will stop after any error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) ListPostures ¶
func (c *Client) ListPostures(ctx context.Context, req *securityposturepb.ListPosturesRequest, opts ...gax.CallOption) *PostureIterator
ListPostures (– This option restricts the visibility of the API to only projects that will (– be labeled as PREVIEW or GOOGLE_INTERNAL by the service. (– option (google.api.api_visibility).restriction = “PREVIEW,GOOGLE_INTERNAL”; Postures Lists Postures in a given organization and location. In case a posture has multiple revisions, the latest revision as per UpdateTime will be returned.
Example ¶
package main import ( "context" securityposture "cloud.google.com/go/securityposture/apiv1" securityposturepb "cloud.google.com/go/securityposture/apiv1/securityposturepb" "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 := securityposture.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &securityposturepb.ListPosturesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/securityposture/apiv1/securityposturepb#ListPosturesRequest. } it := c.ListPostures(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.(*securityposturepb.ListPosturesResponse) } }
Output:
Example (All) ¶
package main import ( "context" securityposture "cloud.google.com/go/securityposture/apiv1" securityposturepb "cloud.google.com/go/securityposture/apiv1/securityposturepb" ) 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 := securityposture.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &securityposturepb.ListPosturesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/securityposture/apiv1/securityposturepb#ListPosturesRequest. } for resp, err := range c.ListPostures(ctx, req).All() { if err != nil { // TODO: Handle error and break/return/continue. Iteration will stop after any error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) UpdatePosture ¶
func (c *Client) UpdatePosture(ctx context.Context, req *securityposturepb.UpdatePostureRequest, opts ...gax.CallOption) (*UpdatePostureOperation, error)
UpdatePosture updates an existing Posture. A new revision of the posture will be created if the revision to be updated is currently deployed on a workload. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the Posture does not exist. Returns a google.rpc.Status with google.rpc.Code.ABORTED if the etag supplied in the request does not match the persisted etag of the Posture. Updatable fields are state, description and policy_sets. State update operation cannot be clubbed with update of description and policy_sets. An ACTIVE posture can be updated to both DRAFT or DEPRECATED states. Postures in DRAFT or DEPRECATED states can only be updated to ACTIVE state.
Example ¶
package main import ( "context" securityposture "cloud.google.com/go/securityposture/apiv1" securityposturepb "cloud.google.com/go/securityposture/apiv1/securityposturepb" ) 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 := securityposture.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &securityposturepb.UpdatePostureRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/securityposture/apiv1/securityposturepb#UpdatePostureRequest. } op, err := c.UpdatePosture(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) UpdatePostureDeployment ¶
func (c *Client) UpdatePostureDeployment(ctx context.Context, req *securityposturepb.UpdatePostureDeploymentRequest, opts ...gax.CallOption) (*UpdatePostureDeploymentOperation, error)
UpdatePostureDeployment updates the parameters of a single PostureDeployment.
Example ¶
package main import ( "context" securityposture "cloud.google.com/go/securityposture/apiv1" securityposturepb "cloud.google.com/go/securityposture/apiv1/securityposturepb" ) 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 := securityposture.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &securityposturepb.UpdatePostureDeploymentRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/securityposture/apiv1/securityposturepb#UpdatePostureDeploymentRequest. } op, err := c.UpdatePostureDeployment(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) UpdatePostureDeploymentOperation ¶
func (c *Client) UpdatePostureDeploymentOperation(name string) *UpdatePostureDeploymentOperation
UpdatePostureDeploymentOperation returns a new UpdatePostureDeploymentOperation from a given name. The name must be that of a previously created UpdatePostureDeploymentOperation, possibly from a different process.
func (*Client) UpdatePostureOperation ¶
func (c *Client) UpdatePostureOperation(name string) *UpdatePostureOperation
UpdatePostureOperation returns a new UpdatePostureOperation from a given name. The name must be that of a previously created UpdatePostureOperation, possibly from a different process.
type CreatePostureDeploymentOperation ¶
type CreatePostureDeploymentOperation struct {
// contains filtered or unexported fields
}
CreatePostureDeploymentOperation manages a long-running operation from CreatePostureDeployment.
func (*CreatePostureDeploymentOperation) Done ¶
func (op *CreatePostureDeploymentOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreatePostureDeploymentOperation) Metadata ¶
func (op *CreatePostureDeploymentOperation) Metadata() (*securityposturepb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*CreatePostureDeploymentOperation) Name ¶
func (op *CreatePostureDeploymentOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*CreatePostureDeploymentOperation) Poll ¶
func (op *CreatePostureDeploymentOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*securityposturepb.PostureDeployment, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*CreatePostureDeploymentOperation) Wait ¶
func (op *CreatePostureDeploymentOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*securityposturepb.PostureDeployment, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type CreatePostureOperation ¶
type CreatePostureOperation struct {
// contains filtered or unexported fields
}
CreatePostureOperation manages a long-running operation from CreatePosture.
func (*CreatePostureOperation) Done ¶
func (op *CreatePostureOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreatePostureOperation) Metadata ¶
func (op *CreatePostureOperation) Metadata() (*securityposturepb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*CreatePostureOperation) Name ¶
func (op *CreatePostureOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*CreatePostureOperation) Poll ¶
func (op *CreatePostureOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*securityposturepb.Posture, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*CreatePostureOperation) Wait ¶
func (op *CreatePostureOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*securityposturepb.Posture, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type DeletePostureDeploymentOperation ¶
type DeletePostureDeploymentOperation struct {
// contains filtered or unexported fields
}
DeletePostureDeploymentOperation manages a long-running operation from DeletePostureDeployment.
func (*DeletePostureDeploymentOperation) Done ¶
func (op *DeletePostureDeploymentOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeletePostureDeploymentOperation) Metadata ¶
func (op *DeletePostureDeploymentOperation) Metadata() (*securityposturepb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DeletePostureDeploymentOperation) Name ¶
func (op *DeletePostureDeploymentOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*DeletePostureDeploymentOperation) Poll ¶
func (op *DeletePostureDeploymentOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeletePostureDeploymentOperation) Wait ¶
func (op *DeletePostureDeploymentOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type DeletePostureOperation ¶
type DeletePostureOperation struct {
// contains filtered or unexported fields
}
DeletePostureOperation manages a long-running operation from DeletePosture.
func (*DeletePostureOperation) Done ¶
func (op *DeletePostureOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeletePostureOperation) Metadata ¶
func (op *DeletePostureOperation) Metadata() (*securityposturepb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DeletePostureOperation) Name ¶
func (op *DeletePostureOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*DeletePostureOperation) Poll ¶
func (op *DeletePostureOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeletePostureOperation) Wait ¶
func (op *DeletePostureOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type ExtractPostureOperation ¶
type ExtractPostureOperation struct {
// contains filtered or unexported fields
}
ExtractPostureOperation manages a long-running operation from ExtractPosture.
func (*ExtractPostureOperation) Done ¶
func (op *ExtractPostureOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*ExtractPostureOperation) Metadata ¶
func (op *ExtractPostureOperation) Metadata() (*securityposturepb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*ExtractPostureOperation) Name ¶
func (op *ExtractPostureOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*ExtractPostureOperation) Poll ¶
func (op *ExtractPostureOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*securityposturepb.Posture, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*ExtractPostureOperation) Wait ¶
func (op *ExtractPostureOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*securityposturepb.Posture, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type LocationIterator ¶
type LocationIterator 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 []*locationpb.Location, nextPageToken string, err error) // contains filtered or unexported fields }
LocationIterator manages a stream of *locationpb.Location.
func (*LocationIterator) All ¶ added in v0.2.0
func (it *LocationIterator) All() iter.Seq2[*locationpb.Location, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*LocationIterator) Next ¶
func (it *LocationIterator) Next() (*locationpb.Location, 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 (*LocationIterator) PageInfo ¶
func (it *LocationIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type OperationIterator ¶
type OperationIterator 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 []*longrunningpb.Operation, nextPageToken string, err error) // contains filtered or unexported fields }
OperationIterator manages a stream of *longrunningpb.Operation.
func (*OperationIterator) All ¶ added in v0.2.0
func (it *OperationIterator) All() iter.Seq2[*longrunningpb.Operation, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*OperationIterator) Next ¶
func (it *OperationIterator) Next() (*longrunningpb.Operation, 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 (*OperationIterator) PageInfo ¶
func (it *OperationIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type PostureDeploymentIterator ¶
type PostureDeploymentIterator 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 []*securityposturepb.PostureDeployment, nextPageToken string, err error) // contains filtered or unexported fields }
PostureDeploymentIterator manages a stream of *securityposturepb.PostureDeployment.
func (*PostureDeploymentIterator) All ¶ added in v0.2.0
func (it *PostureDeploymentIterator) All() iter.Seq2[*securityposturepb.PostureDeployment, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*PostureDeploymentIterator) Next ¶
func (it *PostureDeploymentIterator) Next() (*securityposturepb.PostureDeployment, 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 (*PostureDeploymentIterator) PageInfo ¶
func (it *PostureDeploymentIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type PostureIterator ¶
type PostureIterator 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 []*securityposturepb.Posture, nextPageToken string, err error) // contains filtered or unexported fields }
PostureIterator manages a stream of *securityposturepb.Posture.
func (*PostureIterator) All ¶ added in v0.2.0
func (it *PostureIterator) All() iter.Seq2[*securityposturepb.Posture, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*PostureIterator) Next ¶
func (it *PostureIterator) Next() (*securityposturepb.Posture, 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 (*PostureIterator) PageInfo ¶
func (it *PostureIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type PostureTemplateIterator ¶
type PostureTemplateIterator 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 []*securityposturepb.PostureTemplate, nextPageToken string, err error) // contains filtered or unexported fields }
PostureTemplateIterator manages a stream of *securityposturepb.PostureTemplate.
func (*PostureTemplateIterator) All ¶ added in v0.2.0
func (it *PostureTemplateIterator) All() iter.Seq2[*securityposturepb.PostureTemplate, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*PostureTemplateIterator) Next ¶
func (it *PostureTemplateIterator) Next() (*securityposturepb.PostureTemplate, 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 (*PostureTemplateIterator) PageInfo ¶
func (it *PostureTemplateIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type UpdatePostureDeploymentOperation ¶
type UpdatePostureDeploymentOperation struct {
// contains filtered or unexported fields
}
UpdatePostureDeploymentOperation manages a long-running operation from UpdatePostureDeployment.
func (*UpdatePostureDeploymentOperation) Done ¶
func (op *UpdatePostureDeploymentOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdatePostureDeploymentOperation) Metadata ¶
func (op *UpdatePostureDeploymentOperation) Metadata() (*securityposturepb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UpdatePostureDeploymentOperation) Name ¶
func (op *UpdatePostureDeploymentOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpdatePostureDeploymentOperation) Poll ¶
func (op *UpdatePostureDeploymentOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*securityposturepb.PostureDeployment, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpdatePostureDeploymentOperation) Wait ¶
func (op *UpdatePostureDeploymentOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*securityposturepb.PostureDeployment, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type UpdatePostureOperation ¶
type UpdatePostureOperation struct {
// contains filtered or unexported fields
}
UpdatePostureOperation manages a long-running operation from UpdatePosture.
func (*UpdatePostureOperation) Done ¶
func (op *UpdatePostureOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdatePostureOperation) Metadata ¶
func (op *UpdatePostureOperation) Metadata() (*securityposturepb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UpdatePostureOperation) Name ¶
func (op *UpdatePostureOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpdatePostureOperation) Poll ¶
func (op *UpdatePostureOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*securityposturepb.Posture, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpdatePostureOperation) Wait ¶
func (op *UpdatePostureOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*securityposturepb.Posture, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.