Documentation ¶
Overview ¶
Package config is an auto-generated package for the Infrastructure Manager API.
Creates and manages Google Cloud Platform resources and infrastructure.
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/config/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 := config.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 := &configpb.CreateDeploymentRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/config/apiv1/configpb#CreateDeploymentRequest. } op, err := c.CreateDeployment(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) CreateDeployment(ctx context.Context, req *configpb.CreateDeploymentRequest, ...) (*CreateDeploymentOperation, error)
- func (c *Client) CreateDeploymentOperation(name string) *CreateDeploymentOperation
- func (c *Client) CreatePreview(ctx context.Context, req *configpb.CreatePreviewRequest, ...) (*CreatePreviewOperation, error)
- func (c *Client) CreatePreviewOperation(name string) *CreatePreviewOperation
- func (c *Client) DeleteDeployment(ctx context.Context, req *configpb.DeleteDeploymentRequest, ...) (*DeleteDeploymentOperation, error)
- func (c *Client) DeleteDeploymentOperation(name string) *DeleteDeploymentOperation
- func (c *Client) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, ...) error
- func (c *Client) DeletePreview(ctx context.Context, req *configpb.DeletePreviewRequest, ...) (*DeletePreviewOperation, error)
- func (c *Client) DeletePreviewOperation(name string) *DeletePreviewOperation
- func (c *Client) DeleteStatefile(ctx context.Context, req *configpb.DeleteStatefileRequest, ...) error
- func (c *Client) ExportDeploymentStatefile(ctx context.Context, req *configpb.ExportDeploymentStatefileRequest, ...) (*configpb.Statefile, error)
- func (c *Client) ExportLockInfo(ctx context.Context, req *configpb.ExportLockInfoRequest, ...) (*configpb.LockInfo, error)
- func (c *Client) ExportPreviewResult(ctx context.Context, req *configpb.ExportPreviewResultRequest, ...) (*configpb.ExportPreviewResultResponse, error)
- func (c *Client) ExportRevisionStatefile(ctx context.Context, req *configpb.ExportRevisionStatefileRequest, ...) (*configpb.Statefile, error)
- func (c *Client) GetDeployment(ctx context.Context, req *configpb.GetDeploymentRequest, ...) (*configpb.Deployment, error)
- func (c *Client) GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
- 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) GetPreview(ctx context.Context, req *configpb.GetPreviewRequest, opts ...gax.CallOption) (*configpb.Preview, error)
- func (c *Client) GetResource(ctx context.Context, req *configpb.GetResourceRequest, opts ...gax.CallOption) (*configpb.Resource, error)
- func (c *Client) GetRevision(ctx context.Context, req *configpb.GetRevisionRequest, opts ...gax.CallOption) (*configpb.Revision, error)
- func (c *Client) GetTerraformVersion(ctx context.Context, req *configpb.GetTerraformVersionRequest, ...) (*configpb.TerraformVersion, error)
- func (c *Client) ImportStatefile(ctx context.Context, req *configpb.ImportStatefileRequest, ...) (*configpb.Statefile, error)
- func (c *Client) ListDeployments(ctx context.Context, req *configpb.ListDeploymentsRequest, ...) *DeploymentIterator
- 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) ListPreviews(ctx context.Context, req *configpb.ListPreviewsRequest, opts ...gax.CallOption) *PreviewIterator
- func (c *Client) ListResources(ctx context.Context, req *configpb.ListResourcesRequest, ...) *ResourceIterator
- func (c *Client) ListRevisions(ctx context.Context, req *configpb.ListRevisionsRequest, ...) *RevisionIterator
- func (c *Client) ListTerraformVersions(ctx context.Context, req *configpb.ListTerraformVersionsRequest, ...) *TerraformVersionIterator
- func (c *Client) LockDeployment(ctx context.Context, req *configpb.LockDeploymentRequest, ...) (*LockDeploymentOperation, error)
- func (c *Client) LockDeploymentOperation(name string) *LockDeploymentOperation
- func (c *Client) SetIamPolicy(ctx context.Context, req *iampb.SetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
- func (c *Client) TestIamPermissions(ctx context.Context, req *iampb.TestIamPermissionsRequest, ...) (*iampb.TestIamPermissionsResponse, error)
- func (c *Client) UnlockDeployment(ctx context.Context, req *configpb.UnlockDeploymentRequest, ...) (*UnlockDeploymentOperation, error)
- func (c *Client) UnlockDeploymentOperation(name string) *UnlockDeploymentOperation
- func (c *Client) UpdateDeployment(ctx context.Context, req *configpb.UpdateDeploymentRequest, ...) (*UpdateDeploymentOperation, error)
- func (c *Client) UpdateDeploymentOperation(name string) *UpdateDeploymentOperation
- type CreateDeploymentOperation
- func (op *CreateDeploymentOperation) Done() bool
- func (op *CreateDeploymentOperation) Metadata() (*configpb.OperationMetadata, error)
- func (op *CreateDeploymentOperation) Name() string
- func (op *CreateDeploymentOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*configpb.Deployment, error)
- func (op *CreateDeploymentOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*configpb.Deployment, error)
- type CreatePreviewOperation
- func (op *CreatePreviewOperation) Done() bool
- func (op *CreatePreviewOperation) Metadata() (*configpb.OperationMetadata, error)
- func (op *CreatePreviewOperation) Name() string
- func (op *CreatePreviewOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*configpb.Preview, error)
- func (op *CreatePreviewOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*configpb.Preview, error)
- type DeleteDeploymentOperation
- func (op *DeleteDeploymentOperation) Done() bool
- func (op *DeleteDeploymentOperation) Metadata() (*configpb.OperationMetadata, error)
- func (op *DeleteDeploymentOperation) Name() string
- func (op *DeleteDeploymentOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*configpb.Deployment, error)
- func (op *DeleteDeploymentOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*configpb.Deployment, error)
- type DeletePreviewOperation
- func (op *DeletePreviewOperation) Done() bool
- func (op *DeletePreviewOperation) Metadata() (*configpb.OperationMetadata, error)
- func (op *DeletePreviewOperation) Name() string
- func (op *DeletePreviewOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*configpb.Preview, error)
- func (op *DeletePreviewOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*configpb.Preview, error)
- type DeploymentIterator
- type LocationIterator
- type LockDeploymentOperation
- func (op *LockDeploymentOperation) Done() bool
- func (op *LockDeploymentOperation) Metadata() (*configpb.OperationMetadata, error)
- func (op *LockDeploymentOperation) Name() string
- func (op *LockDeploymentOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*configpb.Deployment, error)
- func (op *LockDeploymentOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*configpb.Deployment, error)
- type OperationIterator
- type PreviewIterator
- type ResourceIterator
- type RevisionIterator
- type TerraformVersionIterator
- type UnlockDeploymentOperation
- func (op *UnlockDeploymentOperation) Done() bool
- func (op *UnlockDeploymentOperation) Metadata() (*configpb.OperationMetadata, error)
- func (op *UnlockDeploymentOperation) Name() string
- func (op *UnlockDeploymentOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*configpb.Deployment, error)
- func (op *UnlockDeploymentOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*configpb.Deployment, error)
- type UpdateDeploymentOperation
- func (op *UpdateDeploymentOperation) Done() bool
- func (op *UpdateDeploymentOperation) Metadata() (*configpb.OperationMetadata, error)
- func (op *UpdateDeploymentOperation) Name() string
- func (op *UpdateDeploymentOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*configpb.Deployment, error)
- func (op *UpdateDeploymentOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*configpb.Deployment, error)
Examples ¶
- Client.CancelOperation
- Client.CreateDeployment
- Client.CreatePreview
- Client.DeleteDeployment
- Client.DeleteOperation
- Client.DeletePreview
- Client.DeleteStatefile
- Client.ExportDeploymentStatefile
- Client.ExportLockInfo
- Client.ExportPreviewResult
- Client.ExportRevisionStatefile
- Client.GetDeployment
- Client.GetIamPolicy
- Client.GetLocation
- Client.GetOperation
- Client.GetPreview
- Client.GetResource
- Client.GetRevision
- Client.GetTerraformVersion
- Client.ImportStatefile
- Client.ListDeployments
- Client.ListDeployments (All)
- Client.ListLocations
- Client.ListLocations (All)
- Client.ListOperations
- Client.ListOperations (All)
- Client.ListPreviews
- Client.ListPreviews (All)
- Client.ListResources
- Client.ListResources (All)
- Client.ListRevisions
- Client.ListRevisions (All)
- Client.ListTerraformVersions
- Client.ListTerraformVersions (All)
- Client.LockDeployment
- Client.SetIamPolicy
- Client.TestIamPermissions
- Client.UnlockDeployment
- Client.UpdateDeployment
- 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 { ListDeployments []gax.CallOption GetDeployment []gax.CallOption CreateDeployment []gax.CallOption UpdateDeployment []gax.CallOption DeleteDeployment []gax.CallOption ListRevisions []gax.CallOption GetRevision []gax.CallOption GetResource []gax.CallOption ListResources []gax.CallOption ExportDeploymentStatefile []gax.CallOption ExportRevisionStatefile []gax.CallOption ImportStatefile []gax.CallOption DeleteStatefile []gax.CallOption LockDeployment []gax.CallOption UnlockDeployment []gax.CallOption ExportLockInfo []gax.CallOption CreatePreview []gax.CallOption GetPreview []gax.CallOption ListPreviews []gax.CallOption DeletePreview []gax.CallOption ExportPreviewResult []gax.CallOption ListTerraformVersions []gax.CallOption GetTerraformVersion []gax.CallOption GetLocation []gax.CallOption ListLocations []gax.CallOption GetIamPolicy []gax.CallOption SetIamPolicy []gax.CallOption TestIamPermissions []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 Infrastructure Manager API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
Infrastructure Manager is a managed service that automates the deployment and management of Google Cloud infrastructure resources.
func NewClient ¶
NewClient creates a new config client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
Infrastructure Manager is a managed service that automates the deployment and management of Google Cloud infrastructure resources.
Example ¶
package main import ( "context" config "cloud.google.com/go/config/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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() // TODO: Use client. _ = c }
Output:
func NewRESTClient ¶
NewRESTClient creates a new config rest client.
Infrastructure Manager is a managed service that automates the deployment and management of Google Cloud infrastructure resources.
Example ¶
package main import ( "context" config "cloud.google.com/go/config/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 := config.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" config "cloud.google.com/go/config/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) 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 := config.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) CreateDeployment ¶
func (c *Client) CreateDeployment(ctx context.Context, req *configpb.CreateDeploymentRequest, opts ...gax.CallOption) (*CreateDeploymentOperation, error)
CreateDeployment creates a Deployment.
Example ¶
package main import ( "context" config "cloud.google.com/go/config/apiv1" configpb "cloud.google.com/go/config/apiv1/configpb" ) 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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &configpb.CreateDeploymentRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/config/apiv1/configpb#CreateDeploymentRequest. } op, err := c.CreateDeployment(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) CreateDeploymentOperation ¶
func (c *Client) CreateDeploymentOperation(name string) *CreateDeploymentOperation
CreateDeploymentOperation returns a new CreateDeploymentOperation from a given name. The name must be that of a previously created CreateDeploymentOperation, possibly from a different process.
func (*Client) CreatePreview ¶ added in v0.2.0
func (c *Client) CreatePreview(ctx context.Context, req *configpb.CreatePreviewRequest, opts ...gax.CallOption) (*CreatePreviewOperation, error)
CreatePreview creates a Preview.
Example ¶
package main import ( "context" config "cloud.google.com/go/config/apiv1" configpb "cloud.google.com/go/config/apiv1/configpb" ) 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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &configpb.CreatePreviewRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/config/apiv1/configpb#CreatePreviewRequest. } op, err := c.CreatePreview(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) CreatePreviewOperation ¶ added in v0.2.0
func (c *Client) CreatePreviewOperation(name string) *CreatePreviewOperation
CreatePreviewOperation returns a new CreatePreviewOperation from a given name. The name must be that of a previously created CreatePreviewOperation, possibly from a different process.
func (*Client) DeleteDeployment ¶
func (c *Client) DeleteDeployment(ctx context.Context, req *configpb.DeleteDeploymentRequest, opts ...gax.CallOption) (*DeleteDeploymentOperation, error)
DeleteDeployment deletes a Deployment.
Example ¶
package main import ( "context" config "cloud.google.com/go/config/apiv1" configpb "cloud.google.com/go/config/apiv1/configpb" ) 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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &configpb.DeleteDeploymentRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/config/apiv1/configpb#DeleteDeploymentRequest. } op, err := c.DeleteDeployment(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) DeleteDeploymentOperation ¶
func (c *Client) DeleteDeploymentOperation(name string) *DeleteDeploymentOperation
DeleteDeploymentOperation returns a new DeleteDeploymentOperation from a given name. The name must be that of a previously created DeleteDeploymentOperation, 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" config "cloud.google.com/go/config/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) 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 := config.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) DeletePreview ¶ added in v0.2.0
func (c *Client) DeletePreview(ctx context.Context, req *configpb.DeletePreviewRequest, opts ...gax.CallOption) (*DeletePreviewOperation, error)
DeletePreview deletes a Preview.
Example ¶
package main import ( "context" config "cloud.google.com/go/config/apiv1" configpb "cloud.google.com/go/config/apiv1/configpb" ) 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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &configpb.DeletePreviewRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/config/apiv1/configpb#DeletePreviewRequest. } op, err := c.DeletePreview(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) DeletePreviewOperation ¶ added in v0.2.0
func (c *Client) DeletePreviewOperation(name string) *DeletePreviewOperation
DeletePreviewOperation returns a new DeletePreviewOperation from a given name. The name must be that of a previously created DeletePreviewOperation, possibly from a different process.
func (*Client) DeleteStatefile ¶
func (c *Client) DeleteStatefile(ctx context.Context, req *configpb.DeleteStatefileRequest, opts ...gax.CallOption) error
DeleteStatefile deletes Terraform state file in a given deployment.
Example ¶
package main import ( "context" config "cloud.google.com/go/config/apiv1" configpb "cloud.google.com/go/config/apiv1/configpb" ) 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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &configpb.DeleteStatefileRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/config/apiv1/configpb#DeleteStatefileRequest. } err = c.DeleteStatefile(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*Client) ExportDeploymentStatefile ¶
func (c *Client) ExportDeploymentStatefile(ctx context.Context, req *configpb.ExportDeploymentStatefileRequest, opts ...gax.CallOption) (*configpb.Statefile, error)
ExportDeploymentStatefile exports Terraform state file from a given deployment.
Example ¶
package main import ( "context" config "cloud.google.com/go/config/apiv1" configpb "cloud.google.com/go/config/apiv1/configpb" ) 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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &configpb.ExportDeploymentStatefileRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/config/apiv1/configpb#ExportDeploymentStatefileRequest. } resp, err := c.ExportDeploymentStatefile(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) ExportLockInfo ¶
func (c *Client) ExportLockInfo(ctx context.Context, req *configpb.ExportLockInfoRequest, opts ...gax.CallOption) (*configpb.LockInfo, error)
ExportLockInfo exports the lock info on a locked deployment.
Example ¶
package main import ( "context" config "cloud.google.com/go/config/apiv1" configpb "cloud.google.com/go/config/apiv1/configpb" ) 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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &configpb.ExportLockInfoRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/config/apiv1/configpb#ExportLockInfoRequest. } resp, err := c.ExportLockInfo(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) ExportPreviewResult ¶ added in v0.2.0
func (c *Client) ExportPreviewResult(ctx context.Context, req *configpb.ExportPreviewResultRequest, opts ...gax.CallOption) (*configpb.ExportPreviewResultResponse, error)
ExportPreviewResult export Preview results.
Example ¶
package main import ( "context" config "cloud.google.com/go/config/apiv1" configpb "cloud.google.com/go/config/apiv1/configpb" ) 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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &configpb.ExportPreviewResultRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/config/apiv1/configpb#ExportPreviewResultRequest. } resp, err := c.ExportPreviewResult(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) ExportRevisionStatefile ¶
func (c *Client) ExportRevisionStatefile(ctx context.Context, req *configpb.ExportRevisionStatefileRequest, opts ...gax.CallOption) (*configpb.Statefile, error)
ExportRevisionStatefile exports Terraform state file from a given revision.
Example ¶
package main import ( "context" config "cloud.google.com/go/config/apiv1" configpb "cloud.google.com/go/config/apiv1/configpb" ) 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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &configpb.ExportRevisionStatefileRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/config/apiv1/configpb#ExportRevisionStatefileRequest. } resp, err := c.ExportRevisionStatefile(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) GetDeployment ¶
func (c *Client) GetDeployment(ctx context.Context, req *configpb.GetDeploymentRequest, opts ...gax.CallOption) (*configpb.Deployment, error)
GetDeployment gets details about a Deployment.
Example ¶
package main import ( "context" config "cloud.google.com/go/config/apiv1" configpb "cloud.google.com/go/config/apiv1/configpb" ) 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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &configpb.GetDeploymentRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/config/apiv1/configpb#GetDeploymentRequest. } resp, err := c.GetDeployment(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) GetIamPolicy ¶
func (c *Client) GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
GetIamPolicy gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Example ¶
package main import ( "context" config "cloud.google.com/go/config/apiv1" iampb "cloud.google.com/go/iam/apiv1/iampb" ) 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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &iampb.GetIamPolicyRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#GetIamPolicyRequest. } resp, err := c.GetIamPolicy(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
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" config "cloud.google.com/go/config/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 := config.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" config "cloud.google.com/go/config/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) 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 := config.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) GetPreview ¶ added in v0.2.0
func (c *Client) GetPreview(ctx context.Context, req *configpb.GetPreviewRequest, opts ...gax.CallOption) (*configpb.Preview, error)
GetPreview gets details about a Preview.
Example ¶
package main import ( "context" config "cloud.google.com/go/config/apiv1" configpb "cloud.google.com/go/config/apiv1/configpb" ) 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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &configpb.GetPreviewRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/config/apiv1/configpb#GetPreviewRequest. } resp, err := c.GetPreview(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) GetResource ¶
func (c *Client) GetResource(ctx context.Context, req *configpb.GetResourceRequest, opts ...gax.CallOption) (*configpb.Resource, error)
GetResource gets details about a Resource deployed by Infra Manager.
Example ¶
package main import ( "context" config "cloud.google.com/go/config/apiv1" configpb "cloud.google.com/go/config/apiv1/configpb" ) 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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &configpb.GetResourceRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/config/apiv1/configpb#GetResourceRequest. } resp, err := c.GetResource(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) GetRevision ¶
func (c *Client) GetRevision(ctx context.Context, req *configpb.GetRevisionRequest, opts ...gax.CallOption) (*configpb.Revision, error)
GetRevision gets details about a Revision.
Example ¶
package main import ( "context" config "cloud.google.com/go/config/apiv1" configpb "cloud.google.com/go/config/apiv1/configpb" ) 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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &configpb.GetRevisionRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/config/apiv1/configpb#GetRevisionRequest. } resp, err := c.GetRevision(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) GetTerraformVersion ¶ added in v0.3.0
func (c *Client) GetTerraformVersion(ctx context.Context, req *configpb.GetTerraformVersionRequest, opts ...gax.CallOption) (*configpb.TerraformVersion, error)
GetTerraformVersion gets details about a TerraformVersion.
Example ¶
package main import ( "context" config "cloud.google.com/go/config/apiv1" configpb "cloud.google.com/go/config/apiv1/configpb" ) 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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &configpb.GetTerraformVersionRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/config/apiv1/configpb#GetTerraformVersionRequest. } resp, err := c.GetTerraformVersion(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) ImportStatefile ¶
func (c *Client) ImportStatefile(ctx context.Context, req *configpb.ImportStatefileRequest, opts ...gax.CallOption) (*configpb.Statefile, error)
ImportStatefile imports Terraform state file in a given deployment. The state file does not take effect until the Deployment has been unlocked.
Example ¶
package main import ( "context" config "cloud.google.com/go/config/apiv1" configpb "cloud.google.com/go/config/apiv1/configpb" ) 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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &configpb.ImportStatefileRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/config/apiv1/configpb#ImportStatefileRequest. } resp, err := c.ImportStatefile(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) ListDeployments ¶
func (c *Client) ListDeployments(ctx context.Context, req *configpb.ListDeploymentsRequest, opts ...gax.CallOption) *DeploymentIterator
ListDeployments lists Deployments in a given project and location.
Example ¶
package main import ( "context" config "cloud.google.com/go/config/apiv1" configpb "cloud.google.com/go/config/apiv1/configpb" "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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &configpb.ListDeploymentsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/config/apiv1/configpb#ListDeploymentsRequest. } it := c.ListDeployments(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.(*configpb.ListDeploymentsResponse) } }
Output:
Example (All) ¶
package main import ( "context" config "cloud.google.com/go/config/apiv1" configpb "cloud.google.com/go/config/apiv1/configpb" ) 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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &configpb.ListDeploymentsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/config/apiv1/configpb#ListDeploymentsRequest. } for resp, err := range c.ListDeployments(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) 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" config "cloud.google.com/go/config/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 := config.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" config "cloud.google.com/go/config/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 := config.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" config "cloud.google.com/go/config/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" "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 := config.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" config "cloud.google.com/go/config/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) 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 := config.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) ListPreviews ¶ added in v0.2.0
func (c *Client) ListPreviews(ctx context.Context, req *configpb.ListPreviewsRequest, opts ...gax.CallOption) *PreviewIterator
ListPreviews lists Previews in a given project and location.
Example ¶
package main import ( "context" config "cloud.google.com/go/config/apiv1" configpb "cloud.google.com/go/config/apiv1/configpb" "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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &configpb.ListPreviewsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/config/apiv1/configpb#ListPreviewsRequest. } it := c.ListPreviews(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.(*configpb.ListPreviewsResponse) } }
Output:
Example (All) ¶
package main import ( "context" config "cloud.google.com/go/config/apiv1" configpb "cloud.google.com/go/config/apiv1/configpb" ) 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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &configpb.ListPreviewsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/config/apiv1/configpb#ListPreviewsRequest. } for resp, err := range c.ListPreviews(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) ListResources ¶
func (c *Client) ListResources(ctx context.Context, req *configpb.ListResourcesRequest, opts ...gax.CallOption) *ResourceIterator
ListResources lists Resources in a given revision.
Example ¶
package main import ( "context" config "cloud.google.com/go/config/apiv1" configpb "cloud.google.com/go/config/apiv1/configpb" "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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &configpb.ListResourcesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/config/apiv1/configpb#ListResourcesRequest. } it := c.ListResources(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.(*configpb.ListResourcesResponse) } }
Output:
Example (All) ¶
package main import ( "context" config "cloud.google.com/go/config/apiv1" configpb "cloud.google.com/go/config/apiv1/configpb" ) 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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &configpb.ListResourcesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/config/apiv1/configpb#ListResourcesRequest. } for resp, err := range c.ListResources(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) ListRevisions ¶
func (c *Client) ListRevisions(ctx context.Context, req *configpb.ListRevisionsRequest, opts ...gax.CallOption) *RevisionIterator
ListRevisions lists Revisions of a deployment.
Example ¶
package main import ( "context" config "cloud.google.com/go/config/apiv1" configpb "cloud.google.com/go/config/apiv1/configpb" "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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &configpb.ListRevisionsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/config/apiv1/configpb#ListRevisionsRequest. } it := c.ListRevisions(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.(*configpb.ListRevisionsResponse) } }
Output:
Example (All) ¶
package main import ( "context" config "cloud.google.com/go/config/apiv1" configpb "cloud.google.com/go/config/apiv1/configpb" ) 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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &configpb.ListRevisionsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/config/apiv1/configpb#ListRevisionsRequest. } for resp, err := range c.ListRevisions(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) ListTerraformVersions ¶ added in v0.3.0
func (c *Client) ListTerraformVersions(ctx context.Context, req *configpb.ListTerraformVersionsRequest, opts ...gax.CallOption) *TerraformVersionIterator
ListTerraformVersions lists TerraformVersions in a given project and location.
Example ¶
package main import ( "context" config "cloud.google.com/go/config/apiv1" configpb "cloud.google.com/go/config/apiv1/configpb" "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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &configpb.ListTerraformVersionsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/config/apiv1/configpb#ListTerraformVersionsRequest. } it := c.ListTerraformVersions(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.(*configpb.ListTerraformVersionsResponse) } }
Output:
Example (All) ¶
package main import ( "context" config "cloud.google.com/go/config/apiv1" configpb "cloud.google.com/go/config/apiv1/configpb" ) 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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &configpb.ListTerraformVersionsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/config/apiv1/configpb#ListTerraformVersionsRequest. } for resp, err := range c.ListTerraformVersions(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) LockDeployment ¶
func (c *Client) LockDeployment(ctx context.Context, req *configpb.LockDeploymentRequest, opts ...gax.CallOption) (*LockDeploymentOperation, error)
LockDeployment locks a deployment.
Example ¶
package main import ( "context" config "cloud.google.com/go/config/apiv1" configpb "cloud.google.com/go/config/apiv1/configpb" ) 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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &configpb.LockDeploymentRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/config/apiv1/configpb#LockDeploymentRequest. } op, err := c.LockDeployment(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) LockDeploymentOperation ¶
func (c *Client) LockDeploymentOperation(name string) *LockDeploymentOperation
LockDeploymentOperation returns a new LockDeploymentOperation from a given name. The name must be that of a previously created LockDeploymentOperation, possibly from a different process.
func (*Client) SetIamPolicy ¶
func (c *Client) SetIamPolicy(ctx context.Context, req *iampb.SetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
SetIamPolicy sets the access control policy on the specified resource. Replaces any existing policy.
Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Example ¶
package main import ( "context" config "cloud.google.com/go/config/apiv1" iampb "cloud.google.com/go/iam/apiv1/iampb" ) 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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &iampb.SetIamPolicyRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#SetIamPolicyRequest. } resp, err := c.SetIamPolicy(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) TestIamPermissions ¶
func (c *Client) TestIamPermissions(ctx context.Context, req *iampb.TestIamPermissionsRequest, opts ...gax.CallOption) (*iampb.TestIamPermissionsResponse, error)
TestIamPermissions returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning.
Example ¶
package main import ( "context" config "cloud.google.com/go/config/apiv1" iampb "cloud.google.com/go/iam/apiv1/iampb" ) 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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &iampb.TestIamPermissionsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#TestIamPermissionsRequest. } resp, err := c.TestIamPermissions(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) UnlockDeployment ¶
func (c *Client) UnlockDeployment(ctx context.Context, req *configpb.UnlockDeploymentRequest, opts ...gax.CallOption) (*UnlockDeploymentOperation, error)
UnlockDeployment unlocks a locked deployment.
Example ¶
package main import ( "context" config "cloud.google.com/go/config/apiv1" configpb "cloud.google.com/go/config/apiv1/configpb" ) 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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &configpb.UnlockDeploymentRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/config/apiv1/configpb#UnlockDeploymentRequest. } op, err := c.UnlockDeployment(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) UnlockDeploymentOperation ¶
func (c *Client) UnlockDeploymentOperation(name string) *UnlockDeploymentOperation
UnlockDeploymentOperation returns a new UnlockDeploymentOperation from a given name. The name must be that of a previously created UnlockDeploymentOperation, possibly from a different process.
func (*Client) UpdateDeployment ¶
func (c *Client) UpdateDeployment(ctx context.Context, req *configpb.UpdateDeploymentRequest, opts ...gax.CallOption) (*UpdateDeploymentOperation, error)
UpdateDeployment updates a Deployment.
Example ¶
package main import ( "context" config "cloud.google.com/go/config/apiv1" configpb "cloud.google.com/go/config/apiv1/configpb" ) 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 := config.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &configpb.UpdateDeploymentRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/config/apiv1/configpb#UpdateDeploymentRequest. } op, err := c.UpdateDeployment(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) UpdateDeploymentOperation ¶
func (c *Client) UpdateDeploymentOperation(name string) *UpdateDeploymentOperation
UpdateDeploymentOperation returns a new UpdateDeploymentOperation from a given name. The name must be that of a previously created UpdateDeploymentOperation, possibly from a different process.
type CreateDeploymentOperation ¶
type CreateDeploymentOperation struct {
// contains filtered or unexported fields
}
CreateDeploymentOperation manages a long-running operation from CreateDeployment.
func (*CreateDeploymentOperation) Done ¶
func (op *CreateDeploymentOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateDeploymentOperation) Metadata ¶
func (op *CreateDeploymentOperation) Metadata() (*configpb.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 (*CreateDeploymentOperation) Name ¶
func (op *CreateDeploymentOperation) 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 (*CreateDeploymentOperation) Poll ¶
func (op *CreateDeploymentOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*configpb.Deployment, 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 (*CreateDeploymentOperation) Wait ¶
func (op *CreateDeploymentOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*configpb.Deployment, 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 CreatePreviewOperation ¶ added in v0.2.0
type CreatePreviewOperation struct {
// contains filtered or unexported fields
}
CreatePreviewOperation manages a long-running operation from CreatePreview.
func (*CreatePreviewOperation) Done ¶ added in v0.2.0
func (op *CreatePreviewOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreatePreviewOperation) Metadata ¶ added in v0.2.0
func (op *CreatePreviewOperation) Metadata() (*configpb.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 (*CreatePreviewOperation) Name ¶ added in v0.2.0
func (op *CreatePreviewOperation) 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 (*CreatePreviewOperation) Poll ¶ added in v0.2.0
func (op *CreatePreviewOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*configpb.Preview, 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 (*CreatePreviewOperation) Wait ¶ added in v0.2.0
func (op *CreatePreviewOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*configpb.Preview, 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 DeleteDeploymentOperation ¶
type DeleteDeploymentOperation struct {
// contains filtered or unexported fields
}
DeleteDeploymentOperation manages a long-running operation from DeleteDeployment.
func (*DeleteDeploymentOperation) Done ¶
func (op *DeleteDeploymentOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteDeploymentOperation) Metadata ¶
func (op *DeleteDeploymentOperation) Metadata() (*configpb.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 (*DeleteDeploymentOperation) Name ¶
func (op *DeleteDeploymentOperation) 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 (*DeleteDeploymentOperation) Poll ¶
func (op *DeleteDeploymentOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*configpb.Deployment, 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 (*DeleteDeploymentOperation) Wait ¶
func (op *DeleteDeploymentOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*configpb.Deployment, 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 DeletePreviewOperation ¶ added in v0.2.0
type DeletePreviewOperation struct {
// contains filtered or unexported fields
}
DeletePreviewOperation manages a long-running operation from DeletePreview.
func (*DeletePreviewOperation) Done ¶ added in v0.2.0
func (op *DeletePreviewOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeletePreviewOperation) Metadata ¶ added in v0.2.0
func (op *DeletePreviewOperation) Metadata() (*configpb.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 (*DeletePreviewOperation) Name ¶ added in v0.2.0
func (op *DeletePreviewOperation) 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 (*DeletePreviewOperation) Poll ¶ added in v0.2.0
func (op *DeletePreviewOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*configpb.Preview, 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 (*DeletePreviewOperation) Wait ¶ added in v0.2.0
func (op *DeletePreviewOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*configpb.Preview, 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 DeploymentIterator ¶
type DeploymentIterator 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 []*configpb.Deployment, nextPageToken string, err error) // contains filtered or unexported fields }
DeploymentIterator manages a stream of *configpb.Deployment.
func (*DeploymentIterator) All ¶ added in v1.1.0
func (it *DeploymentIterator) All() iter.Seq2[*configpb.Deployment, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*DeploymentIterator) Next ¶
func (it *DeploymentIterator) Next() (*configpb.Deployment, 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 (*DeploymentIterator) PageInfo ¶
func (it *DeploymentIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
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 v1.1.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 LockDeploymentOperation ¶
type LockDeploymentOperation struct {
// contains filtered or unexported fields
}
LockDeploymentOperation manages a long-running operation from LockDeployment.
func (*LockDeploymentOperation) Done ¶
func (op *LockDeploymentOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*LockDeploymentOperation) Metadata ¶
func (op *LockDeploymentOperation) Metadata() (*configpb.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 (*LockDeploymentOperation) Name ¶
func (op *LockDeploymentOperation) 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 (*LockDeploymentOperation) Poll ¶
func (op *LockDeploymentOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*configpb.Deployment, 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 (*LockDeploymentOperation) Wait ¶
func (op *LockDeploymentOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*configpb.Deployment, 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 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 v1.1.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 PreviewIterator ¶ added in v0.2.0
type PreviewIterator 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 []*configpb.Preview, nextPageToken string, err error) // contains filtered or unexported fields }
PreviewIterator manages a stream of *configpb.Preview.
func (*PreviewIterator) All ¶ added in v1.1.0
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*PreviewIterator) Next ¶ added in v0.2.0
func (it *PreviewIterator) Next() (*configpb.Preview, 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 (*PreviewIterator) PageInfo ¶ added in v0.2.0
func (it *PreviewIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type ResourceIterator ¶
type ResourceIterator 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 []*configpb.Resource, nextPageToken string, err error) // contains filtered or unexported fields }
ResourceIterator manages a stream of *configpb.Resource.
func (*ResourceIterator) All ¶ added in v1.1.0
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*ResourceIterator) Next ¶
func (it *ResourceIterator) Next() (*configpb.Resource, 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 (*ResourceIterator) PageInfo ¶
func (it *ResourceIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type RevisionIterator ¶
type RevisionIterator 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 []*configpb.Revision, nextPageToken string, err error) // contains filtered or unexported fields }
RevisionIterator manages a stream of *configpb.Revision.
func (*RevisionIterator) All ¶ added in v1.1.0
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*RevisionIterator) Next ¶
func (it *RevisionIterator) Next() (*configpb.Revision, 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 (*RevisionIterator) PageInfo ¶
func (it *RevisionIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type TerraformVersionIterator ¶ added in v0.3.0
type TerraformVersionIterator 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 []*configpb.TerraformVersion, nextPageToken string, err error) // contains filtered or unexported fields }
TerraformVersionIterator manages a stream of *configpb.TerraformVersion.
func (*TerraformVersionIterator) All ¶ added in v1.1.0
func (it *TerraformVersionIterator) All() iter.Seq2[*configpb.TerraformVersion, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*TerraformVersionIterator) Next ¶ added in v0.3.0
func (it *TerraformVersionIterator) Next() (*configpb.TerraformVersion, 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 (*TerraformVersionIterator) PageInfo ¶ added in v0.3.0
func (it *TerraformVersionIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type UnlockDeploymentOperation ¶
type UnlockDeploymentOperation struct {
// contains filtered or unexported fields
}
UnlockDeploymentOperation manages a long-running operation from UnlockDeployment.
func (*UnlockDeploymentOperation) Done ¶
func (op *UnlockDeploymentOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UnlockDeploymentOperation) Metadata ¶
func (op *UnlockDeploymentOperation) Metadata() (*configpb.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 (*UnlockDeploymentOperation) Name ¶
func (op *UnlockDeploymentOperation) 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 (*UnlockDeploymentOperation) Poll ¶
func (op *UnlockDeploymentOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*configpb.Deployment, 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 (*UnlockDeploymentOperation) Wait ¶
func (op *UnlockDeploymentOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*configpb.Deployment, 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 UpdateDeploymentOperation ¶
type UpdateDeploymentOperation struct {
// contains filtered or unexported fields
}
UpdateDeploymentOperation manages a long-running operation from UpdateDeployment.
func (*UpdateDeploymentOperation) Done ¶
func (op *UpdateDeploymentOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateDeploymentOperation) Metadata ¶
func (op *UpdateDeploymentOperation) Metadata() (*configpb.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 (*UpdateDeploymentOperation) Name ¶
func (op *UpdateDeploymentOperation) 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 (*UpdateDeploymentOperation) Poll ¶
func (op *UpdateDeploymentOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*configpb.Deployment, 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 (*UpdateDeploymentOperation) Wait ¶
func (op *UpdateDeploymentOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*configpb.Deployment, 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.