package binaryauthorization
import "cloud.google.com/go/binaryauthorization/apiv1beta1"
Package binaryauthorization is an auto-generated package for the Binary Authorization API.
The management interface for Binary Authorization, a system providing policy control for images deployed to Kubernetes Engine clusters, Anthos clusters on VMware, and Cloud Run.
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/binaryauthorization/apiv1beta1@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 := binaryauthorization.NewBinauthzManagementServiceV1Beta1Client(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 := &binaryauthorizationpb.CreateAttestorRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/binaryauthorization/apiv1beta1/binaryauthorizationpb#CreateAttestorRequest. } resp, err := c.CreateAttestor(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp
Use of Context
The ctx passed to NewBinauthzManagementServiceV1Beta1Client 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 AttestorIterator
- func (it *AttestorIterator) All() iter.Seq2[*binaryauthorizationpb.Attestor, error]
- func (it *AttestorIterator) Next() (*binaryauthorizationpb.Attestor, error)
- func (it *AttestorIterator) PageInfo() *iterator.PageInfo
- type BinauthzManagementServiceV1Beta1CallOptions
- type BinauthzManagementServiceV1Beta1Client
- func NewBinauthzManagementServiceV1Beta1Client(ctx context.Context, opts ...option.ClientOption) (*BinauthzManagementServiceV1Beta1Client, error)
- func NewBinauthzManagementServiceV1Beta1RESTClient(ctx context.Context, opts ...option.ClientOption) (*BinauthzManagementServiceV1Beta1Client, error)
- func (c *BinauthzManagementServiceV1Beta1Client) Close() error
- func (c *BinauthzManagementServiceV1Beta1Client) Connection() *grpc.ClientConn
- func (c *BinauthzManagementServiceV1Beta1Client) CreateAttestor(ctx context.Context, req *binaryauthorizationpb.CreateAttestorRequest, opts ...gax.CallOption) (*binaryauthorizationpb.Attestor, error)
- func (c *BinauthzManagementServiceV1Beta1Client) DeleteAttestor(ctx context.Context, req *binaryauthorizationpb.DeleteAttestorRequest, opts ...gax.CallOption) error
- func (c *BinauthzManagementServiceV1Beta1Client) GetAttestor(ctx context.Context, req *binaryauthorizationpb.GetAttestorRequest, opts ...gax.CallOption) (*binaryauthorizationpb.Attestor, error)
- func (c *BinauthzManagementServiceV1Beta1Client) GetPolicy(ctx context.Context, req *binaryauthorizationpb.GetPolicyRequest, opts ...gax.CallOption) (*binaryauthorizationpb.Policy, error)
- func (c *BinauthzManagementServiceV1Beta1Client) ListAttestors(ctx context.Context, req *binaryauthorizationpb.ListAttestorsRequest, opts ...gax.CallOption) *AttestorIterator
- func (c *BinauthzManagementServiceV1Beta1Client) UpdateAttestor(ctx context.Context, req *binaryauthorizationpb.UpdateAttestorRequest, opts ...gax.CallOption) (*binaryauthorizationpb.Attestor, error)
- func (c *BinauthzManagementServiceV1Beta1Client) UpdatePolicy(ctx context.Context, req *binaryauthorizationpb.UpdatePolicyRequest, opts ...gax.CallOption) (*binaryauthorizationpb.Policy, error)
- type SystemPolicyV1Beta1CallOptions
- type SystemPolicyV1Beta1Client
- func NewSystemPolicyV1Beta1Client(ctx context.Context, opts ...option.ClientOption) (*SystemPolicyV1Beta1Client, error)
- func NewSystemPolicyV1Beta1RESTClient(ctx context.Context, opts ...option.ClientOption) (*SystemPolicyV1Beta1Client, error)
- func (c *SystemPolicyV1Beta1Client) Close() error
- func (c *SystemPolicyV1Beta1Client) Connection() *grpc.ClientConn
- func (c *SystemPolicyV1Beta1Client) GetSystemPolicy(ctx context.Context, req *binaryauthorizationpb.GetSystemPolicyRequest, opts ...gax.CallOption) (*binaryauthorizationpb.Policy, error)
Examples ¶
- BinauthzManagementServiceV1Beta1Client.CreateAttestor
- BinauthzManagementServiceV1Beta1Client.DeleteAttestor
- BinauthzManagementServiceV1Beta1Client.GetAttestor
- BinauthzManagementServiceV1Beta1Client.GetPolicy
- BinauthzManagementServiceV1Beta1Client.ListAttestors
- BinauthzManagementServiceV1Beta1Client.ListAttestors (All)
- BinauthzManagementServiceV1Beta1Client.UpdateAttestor
- BinauthzManagementServiceV1Beta1Client.UpdatePolicy
- NewBinauthzManagementServiceV1Beta1Client
- NewBinauthzManagementServiceV1Beta1RESTClient
- NewSystemPolicyV1Beta1Client
- NewSystemPolicyV1Beta1RESTClient
- SystemPolicyV1Beta1Client.GetSystemPolicy
Functions ¶
func DefaultAuthScopes ¶
func DefaultAuthScopes() []string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
Types ¶
type AttestorIterator ¶
type AttestorIterator 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 []*binaryauthorizationpb.Attestor, nextPageToken string, err error) // contains filtered or unexported fields }
AttestorIterator manages a stream of *binaryauthorizationpb.Attestor.
func (*AttestorIterator) All ¶
func (it *AttestorIterator) All() iter.Seq2[*binaryauthorizationpb.Attestor, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*AttestorIterator) Next ¶
func (it *AttestorIterator) Next() (*binaryauthorizationpb.Attestor, 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 (*AttestorIterator) PageInfo ¶
func (it *AttestorIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type BinauthzManagementServiceV1Beta1CallOptions ¶
type BinauthzManagementServiceV1Beta1CallOptions struct { GetPolicy []gax.CallOption UpdatePolicy []gax.CallOption CreateAttestor []gax.CallOption GetAttestor []gax.CallOption UpdateAttestor []gax.CallOption ListAttestors []gax.CallOption DeleteAttestor []gax.CallOption }
BinauthzManagementServiceV1Beta1CallOptions contains the retry settings for each method of BinauthzManagementServiceV1Beta1Client.
type BinauthzManagementServiceV1Beta1Client ¶
type BinauthzManagementServiceV1Beta1Client struct { // The call options for this service. CallOptions *BinauthzManagementServiceV1Beta1CallOptions // contains filtered or unexported fields }
BinauthzManagementServiceV1Beta1Client is a client for interacting with Binary Authorization API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
Google Cloud Management Service for Binary Authorization admission policies and attestation authorities.
This API implements a REST model with the following objects:
Policy Attestor
func NewBinauthzManagementServiceV1Beta1Client ¶
func NewBinauthzManagementServiceV1Beta1Client(ctx context.Context, opts ...option.ClientOption) (*BinauthzManagementServiceV1Beta1Client, error)
NewBinauthzManagementServiceV1Beta1Client creates a new binauthz management service v1 beta1 client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
Google Cloud Management Service for Binary Authorization admission policies and attestation authorities.
This API implements a REST model with the following objects:
Policy Attestor
Example¶
Code:play
package main import ( "context" binaryauthorization "cloud.google.com/go/binaryauthorization/apiv1beta1" ) 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 := binaryauthorization.NewBinauthzManagementServiceV1Beta1Client(ctx) if err != nil { // TODO: Handle error. } defer c.Close() // TODO: Use client. _ = c }
func NewBinauthzManagementServiceV1Beta1RESTClient ¶
func NewBinauthzManagementServiceV1Beta1RESTClient(ctx context.Context, opts ...option.ClientOption) (*BinauthzManagementServiceV1Beta1Client, error)
NewBinauthzManagementServiceV1Beta1RESTClient creates a new binauthz management service v1 beta1 rest client.
Google Cloud Management Service for Binary Authorization admission policies and attestation authorities.
This API implements a REST model with the following objects:
Policy Attestor
Example¶
Code:play
package main import ( "context" binaryauthorization "cloud.google.com/go/binaryauthorization/apiv1beta1" ) 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 := binaryauthorization.NewBinauthzManagementServiceV1Beta1RESTClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() // TODO: Use client. _ = c }
func (*BinauthzManagementServiceV1Beta1Client) Close ¶
func (c *BinauthzManagementServiceV1Beta1Client) Close() error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*BinauthzManagementServiceV1Beta1Client) Connection ¶
func (c *BinauthzManagementServiceV1Beta1Client) 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 (*BinauthzManagementServiceV1Beta1Client) CreateAttestor ¶
func (c *BinauthzManagementServiceV1Beta1Client) CreateAttestor(ctx context.Context, req *binaryauthorizationpb.CreateAttestorRequest, opts ...gax.CallOption) (*binaryauthorizationpb.Attestor, error)
CreateAttestor creates an attestor, and returns a copy of the new
attestor. Returns NOT_FOUND if the project does not exist,
INVALID_ARGUMENT if the request is malformed, ALREADY_EXISTS if the
attestor already exists.
Code:play
Example¶
package main
import (
"context"
binaryauthorization "cloud.google.com/go/binaryauthorization/apiv1beta1"
binaryauthorizationpb "cloud.google.com/go/binaryauthorization/apiv1beta1/binaryauthorizationpb"
)
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 := binaryauthorization.NewBinauthzManagementServiceV1Beta1Client(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &binaryauthorizationpb.CreateAttestorRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/binaryauthorization/apiv1beta1/binaryauthorizationpb#CreateAttestorRequest.
}
resp, err := c.CreateAttestor(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*BinauthzManagementServiceV1Beta1Client) DeleteAttestor ¶
func (c *BinauthzManagementServiceV1Beta1Client) DeleteAttestor(ctx context.Context, req *binaryauthorizationpb.DeleteAttestorRequest, opts ...gax.CallOption) error
DeleteAttestor deletes an attestor. Returns NOT_FOUND if the
attestor does not exist.
Code:play
Example¶
package main
import (
"context"
binaryauthorization "cloud.google.com/go/binaryauthorization/apiv1beta1"
binaryauthorizationpb "cloud.google.com/go/binaryauthorization/apiv1beta1/binaryauthorizationpb"
)
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 := binaryauthorization.NewBinauthzManagementServiceV1Beta1Client(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &binaryauthorizationpb.DeleteAttestorRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/binaryauthorization/apiv1beta1/binaryauthorizationpb#DeleteAttestorRequest.
}
err = c.DeleteAttestor(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*BinauthzManagementServiceV1Beta1Client) GetAttestor ¶
func (c *BinauthzManagementServiceV1Beta1Client) GetAttestor(ctx context.Context, req *binaryauthorizationpb.GetAttestorRequest, opts ...gax.CallOption) (*binaryauthorizationpb.Attestor, error)
GetAttestor gets an attestor.
Returns NOT_FOUND if the attestor does not exist.
Code:play
Example¶
package main
import (
"context"
binaryauthorization "cloud.google.com/go/binaryauthorization/apiv1beta1"
binaryauthorizationpb "cloud.google.com/go/binaryauthorization/apiv1beta1/binaryauthorizationpb"
)
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 := binaryauthorization.NewBinauthzManagementServiceV1Beta1Client(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &binaryauthorizationpb.GetAttestorRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/binaryauthorization/apiv1beta1/binaryauthorizationpb#GetAttestorRequest.
}
resp, err := c.GetAttestor(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*BinauthzManagementServiceV1Beta1Client) GetPolicy ¶
func (c *BinauthzManagementServiceV1Beta1Client) GetPolicy(ctx context.Context, req *binaryauthorizationpb.GetPolicyRequest, opts ...gax.CallOption) (*binaryauthorizationpb.Policy, error)
GetPolicy a policy specifies the attestors that must attest to a container image, before the project is allowed to deploy that image. There is at most one policy per project. All image admission requests are permitted if a project has no policy.
Gets the policy for this project. Returns a default
policy if the project does not have one.
Code:play
Example¶
package main
import (
"context"
binaryauthorization "cloud.google.com/go/binaryauthorization/apiv1beta1"
binaryauthorizationpb "cloud.google.com/go/binaryauthorization/apiv1beta1/binaryauthorizationpb"
)
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 := binaryauthorization.NewBinauthzManagementServiceV1Beta1Client(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &binaryauthorizationpb.GetPolicyRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/binaryauthorization/apiv1beta1/binaryauthorizationpb#GetPolicyRequest.
}
resp, err := c.GetPolicy(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*BinauthzManagementServiceV1Beta1Client) ListAttestors ¶
func (c *BinauthzManagementServiceV1Beta1Client) ListAttestors(ctx context.Context, req *binaryauthorizationpb.ListAttestorsRequest, opts ...gax.CallOption) *AttestorIterator
ListAttestors lists attestors.
Returns INVALID_ARGUMENT if the project does not exist.
Code:play
Code:play
Example¶
package main
import (
"context"
binaryauthorization "cloud.google.com/go/binaryauthorization/apiv1beta1"
binaryauthorizationpb "cloud.google.com/go/binaryauthorization/apiv1beta1/binaryauthorizationpb"
"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 := binaryauthorization.NewBinauthzManagementServiceV1Beta1Client(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &binaryauthorizationpb.ListAttestorsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/binaryauthorization/apiv1beta1/binaryauthorizationpb#ListAttestorsRequest.
}
it := c.ListAttestors(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.(*binaryauthorizationpb.ListAttestorsResponse)
}
}
Example (All)¶
package main
import (
"context"
binaryauthorization "cloud.google.com/go/binaryauthorization/apiv1beta1"
binaryauthorizationpb "cloud.google.com/go/binaryauthorization/apiv1beta1/binaryauthorizationpb"
)
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 := binaryauthorization.NewBinauthzManagementServiceV1Beta1Client(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &binaryauthorizationpb.ListAttestorsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/binaryauthorization/apiv1beta1/binaryauthorizationpb#ListAttestorsRequest.
}
for resp, err := range c.ListAttestors(ctx, req).All() {
if err != nil {
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_ = resp
}
}
func (*BinauthzManagementServiceV1Beta1Client) UpdateAttestor ¶
func (c *BinauthzManagementServiceV1Beta1Client) UpdateAttestor(ctx context.Context, req *binaryauthorizationpb.UpdateAttestorRequest, opts ...gax.CallOption) (*binaryauthorizationpb.Attestor, error)
UpdateAttestor updates an attestor.
Returns NOT_FOUND if the attestor does not exist.
Code:play
Example¶
package main
import (
"context"
binaryauthorization "cloud.google.com/go/binaryauthorization/apiv1beta1"
binaryauthorizationpb "cloud.google.com/go/binaryauthorization/apiv1beta1/binaryauthorizationpb"
)
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 := binaryauthorization.NewBinauthzManagementServiceV1Beta1Client(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &binaryauthorizationpb.UpdateAttestorRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/binaryauthorization/apiv1beta1/binaryauthorizationpb#UpdateAttestorRequest.
}
resp, err := c.UpdateAttestor(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*BinauthzManagementServiceV1Beta1Client) UpdatePolicy ¶
func (c *BinauthzManagementServiceV1Beta1Client) UpdatePolicy(ctx context.Context, req *binaryauthorizationpb.UpdatePolicyRequest, opts ...gax.CallOption) (*binaryauthorizationpb.Policy, error)
UpdatePolicy creates or updates a project’s policy, and returns a copy of the
new policy. A policy is always updated as a whole, to avoid race
conditions with concurrent policy enforcement (or management!)
requests. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT
if the request is malformed.
Code:play
Example¶
package main
import (
"context"
binaryauthorization "cloud.google.com/go/binaryauthorization/apiv1beta1"
binaryauthorizationpb "cloud.google.com/go/binaryauthorization/apiv1beta1/binaryauthorizationpb"
)
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 := binaryauthorization.NewBinauthzManagementServiceV1Beta1Client(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &binaryauthorizationpb.UpdatePolicyRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/binaryauthorization/apiv1beta1/binaryauthorizationpb#UpdatePolicyRequest.
}
resp, err := c.UpdatePolicy(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
type SystemPolicyV1Beta1CallOptions ¶
type SystemPolicyV1Beta1CallOptions struct { GetSystemPolicy []gax.CallOption }
SystemPolicyV1Beta1CallOptions contains the retry settings for each method of SystemPolicyV1Beta1Client.
type SystemPolicyV1Beta1Client ¶
type SystemPolicyV1Beta1Client struct { // The call options for this service. CallOptions *SystemPolicyV1Beta1CallOptions // contains filtered or unexported fields }
SystemPolicyV1Beta1Client is a client for interacting with Binary Authorization API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
API for working with the system policy.
func NewSystemPolicyV1Beta1Client ¶
func NewSystemPolicyV1Beta1Client(ctx context.Context, opts ...option.ClientOption) (*SystemPolicyV1Beta1Client, error)
NewSystemPolicyV1Beta1Client creates a new system policy v1 beta1 client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
API for working with the system policy.
Code:play
Example¶
package main
import (
"context"
binaryauthorization "cloud.google.com/go/binaryauthorization/apiv1beta1"
)
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 := binaryauthorization.NewSystemPolicyV1Beta1Client(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func NewSystemPolicyV1Beta1RESTClient ¶
func NewSystemPolicyV1Beta1RESTClient(ctx context.Context, opts ...option.ClientOption) (*SystemPolicyV1Beta1Client, error)
NewSystemPolicyV1Beta1RESTClient creates a new system policy v1 beta1 rest client.
API for working with the system policy.
Code:play
Example¶
package main
import (
"context"
binaryauthorization "cloud.google.com/go/binaryauthorization/apiv1beta1"
)
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 := binaryauthorization.NewSystemPolicyV1Beta1RESTClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func (*SystemPolicyV1Beta1Client) Close ¶
func (c *SystemPolicyV1Beta1Client) Close() error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*SystemPolicyV1Beta1Client) Connection ¶
func (c *SystemPolicyV1Beta1Client) 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 (*SystemPolicyV1Beta1Client) GetSystemPolicy ¶
func (c *SystemPolicyV1Beta1Client) GetSystemPolicy(ctx context.Context, req *binaryauthorizationpb.GetSystemPolicyRequest, opts ...gax.CallOption) (*binaryauthorizationpb.Policy, error)
GetSystemPolicy gets the current system policy in the specified location.
Code:play
Example¶
package main
import (
"context"
binaryauthorization "cloud.google.com/go/binaryauthorization/apiv1beta1"
binaryauthorizationpb "cloud.google.com/go/binaryauthorization/apiv1beta1/binaryauthorizationpb"
)
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 := binaryauthorization.NewSystemPolicyV1Beta1Client(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &binaryauthorizationpb.GetSystemPolicyRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/binaryauthorization/apiv1beta1/binaryauthorizationpb#GetSystemPolicyRequest.
}
resp, err := c.GetSystemPolicy(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
Source Files ¶
auxiliary.go auxiliary_go123.go binauthz_management_service_v1_beta1_client.go doc.go helpers.go system_policy_v1_beta1_client.go version.go
Directories ¶
Path | Synopsis |
---|---|
apiv1beta1/binaryauthorizationpb |
- Version
- v1.9.3 (latest)
- Published
- Jan 2, 2025
- Platform
- linux/amd64
- Imports
- 26 packages
- Last checked
- 6 days ago –
Tools for package owners.