Cloud Deploy API v1 - Package cloud.google.com/go/deploy/apiv1 (v1.4.0)
Package deploy is an auto-generated package for theGoogle Cloud Deploy API.
Example usage
To get started with this package, create a client.
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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.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.
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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&deploypb.ListDeliveryPipelinesRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/deploy/v1#ListDeliveryPipelinesRequest.}it:=c.ListDeliveryPipelines(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}
Use of Context
The ctx passed to NewCloudDeployClient is used for authentication requests andfor 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.
For information about setting deadlines, reusing contexts, and moreplease visithttps://pkg.go.dev/cloud.google.com/go.
Functions
func DefaultAuthScopes
funcDefaultAuthScopes()[]stringDefaultAuthScopes reports the default set of authentication scopes to use with this package.
CloudDeployCallOptions
typeCloudDeployCallOptionsstruct{ListDeliveryPipelines[]gax.CallOptionGetDeliveryPipeline[]gax.CallOptionCreateDeliveryPipeline[]gax.CallOptionUpdateDeliveryPipeline[]gax.CallOptionDeleteDeliveryPipeline[]gax.CallOptionListTargets[]gax.CallOptionGetTarget[]gax.CallOptionCreateTarget[]gax.CallOptionUpdateTarget[]gax.CallOptionDeleteTarget[]gax.CallOptionListReleases[]gax.CallOptionGetRelease[]gax.CallOptionCreateRelease[]gax.CallOptionAbandonRelease[]gax.CallOptionApproveRollout[]gax.CallOptionListRollouts[]gax.CallOptionGetRollout[]gax.CallOptionCreateRollout[]gax.CallOptionRetryJob[]gax.CallOptionListJobRuns[]gax.CallOptionGetJobRun[]gax.CallOptionGetConfig[]gax.CallOptionGetLocation[]gax.CallOptionListLocations[]gax.CallOptionGetIamPolicy[]gax.CallOptionSetIamPolicy[]gax.CallOptionTestIamPermissions[]gax.CallOptionCancelOperation[]gax.CallOptionDeleteOperation[]gax.CallOptionGetOperation[]gax.CallOptionListOperations[]gax.CallOption}CloudDeployCallOptions contains the retry settings for each method of CloudDeployClient.
CloudDeployClient
typeCloudDeployClientstruct{// The call options for this service.CallOptions*CloudDeployCallOptions// 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}CloudDeployClient is a client for interacting with Google Cloud Deploy API.Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
CloudDeploy service creates and manages Continuous Delivery operationson Google Cloud Platform via Skaffold (https://skaffold.dev (athttps://skaffold.dev)).
func NewCloudDeployClient
funcNewCloudDeployClient(ctxcontext.Context,opts...option.ClientOption)(*CloudDeployClient,error)NewCloudDeployClient creates a new cloud deploy client based on gRPC.The returned client must be Closed when it is done being used to clean up its underlying connections.
CloudDeploy service creates and manages Continuous Delivery operationson Google Cloud Platform via Skaffold (https://skaffold.dev (athttps://skaffold.dev)).
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()// TODO: Use client._=c}func (*CloudDeployClient) AbandonRelease
func(c*CloudDeployClient)AbandonRelease(ctxcontext.Context,req*deploypb.AbandonReleaseRequest,opts...gax.CallOption)(*deploypb.AbandonReleaseResponse,error)AbandonRelease abandons a Release in the Delivery Pipeline.
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1"deploypb"google.golang.org/genproto/googleapis/cloud/deploy/v1")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&deploypb.AbandonReleaseRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/deploy/v1#AbandonReleaseRequest.}resp,err:=c.AbandonRelease(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*CloudDeployClient) ApproveRollout
func(c*CloudDeployClient)ApproveRollout(ctxcontext.Context,req*deploypb.ApproveRolloutRequest,opts...gax.CallOption)(*deploypb.ApproveRolloutResponse,error)ApproveRollout approves a Rollout.
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1"deploypb"google.golang.org/genproto/googleapis/cloud/deploy/v1")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&deploypb.ApproveRolloutRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/deploy/v1#ApproveRolloutRequest.}resp,err:=c.ApproveRollout(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*CloudDeployClient) CancelOperation
func(c*CloudDeployClient)CancelOperation(ctxcontext.Context,req*longrunningpb.CancelOperationRequest,opts...gax.CallOption)errorCancelOperation is a utility method from google.longrunning.Operations.
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1"longrunningpb"google.golang.org/genproto/googleapis/longrunning")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&longrunningpb.CancelOperationRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/longrunning#CancelOperationRequest.}err=c.CancelOperation(ctx,req)iferr!=nil{// TODO: Handle error.}}func (*CloudDeployClient) Close
func(c*CloudDeployClient)Close()errorClose closes the connection to the API service. The user should invoke this whenthe client is no longer required.
func (*CloudDeployClient) Connection (deprecated)
func(c*CloudDeployClient)Connection()*grpc.ClientConnConnection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not alwaysreturn the same resource.
func (*CloudDeployClient) CreateDeliveryPipeline
func(c*CloudDeployClient)CreateDeliveryPipeline(ctxcontext.Context,req*deploypb.CreateDeliveryPipelineRequest,opts...gax.CallOption)(*CreateDeliveryPipelineOperation,error)CreateDeliveryPipeline creates a new DeliveryPipeline in a given project and location.
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1"deploypb"google.golang.org/genproto/googleapis/cloud/deploy/v1")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&deploypb.CreateDeliveryPipelineRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/deploy/v1#CreateDeliveryPipelineRequest.}op,err:=c.CreateDeliveryPipeline(ctx,req)iferr!=nil{// TODO: Handle error.}resp,err:=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*CloudDeployClient) CreateDeliveryPipelineOperation
func(c*CloudDeployClient)CreateDeliveryPipelineOperation(namestring)*CreateDeliveryPipelineOperationCreateDeliveryPipelineOperation returns a new CreateDeliveryPipelineOperation from a given name.The name must be that of a previously created CreateDeliveryPipelineOperation, possibly from a different process.
func (*CloudDeployClient) CreateRelease
func(c*CloudDeployClient)CreateRelease(ctxcontext.Context,req*deploypb.CreateReleaseRequest,opts...gax.CallOption)(*CreateReleaseOperation,error)CreateRelease creates a new Release in a given project and location.
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1"deploypb"google.golang.org/genproto/googleapis/cloud/deploy/v1")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&deploypb.CreateReleaseRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/deploy/v1#CreateReleaseRequest.}op,err:=c.CreateRelease(ctx,req)iferr!=nil{// TODO: Handle error.}resp,err:=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*CloudDeployClient) CreateReleaseOperation
func(c*CloudDeployClient)CreateReleaseOperation(namestring)*CreateReleaseOperationCreateReleaseOperation returns a new CreateReleaseOperation from a given name.The name must be that of a previously created CreateReleaseOperation, possibly from a different process.
func (*CloudDeployClient) CreateRollout
func(c*CloudDeployClient)CreateRollout(ctxcontext.Context,req*deploypb.CreateRolloutRequest,opts...gax.CallOption)(*CreateRolloutOperation,error)CreateRollout creates a new Rollout in a given project and location.
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1"deploypb"google.golang.org/genproto/googleapis/cloud/deploy/v1")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&deploypb.CreateRolloutRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/deploy/v1#CreateRolloutRequest.}op,err:=c.CreateRollout(ctx,req)iferr!=nil{// TODO: Handle error.}resp,err:=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*CloudDeployClient) CreateRolloutOperation
func(c*CloudDeployClient)CreateRolloutOperation(namestring)*CreateRolloutOperationCreateRolloutOperation returns a new CreateRolloutOperation from a given name.The name must be that of a previously created CreateRolloutOperation, possibly from a different process.
func (*CloudDeployClient) CreateTarget
func(c*CloudDeployClient)CreateTarget(ctxcontext.Context,req*deploypb.CreateTargetRequest,opts...gax.CallOption)(*CreateTargetOperation,error)CreateTarget creates a new Target in a given project and location.
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1"deploypb"google.golang.org/genproto/googleapis/cloud/deploy/v1")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&deploypb.CreateTargetRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/deploy/v1#CreateTargetRequest.}op,err:=c.CreateTarget(ctx,req)iferr!=nil{// TODO: Handle error.}resp,err:=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*CloudDeployClient) CreateTargetOperation
func(c*CloudDeployClient)CreateTargetOperation(namestring)*CreateTargetOperationCreateTargetOperation returns a new CreateTargetOperation from a given name.The name must be that of a previously created CreateTargetOperation, possibly from a different process.
func (*CloudDeployClient) DeleteDeliveryPipeline
func(c*CloudDeployClient)DeleteDeliveryPipeline(ctxcontext.Context,req*deploypb.DeleteDeliveryPipelineRequest,opts...gax.CallOption)(*DeleteDeliveryPipelineOperation,error)DeleteDeliveryPipeline deletes a single DeliveryPipeline.
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1"deploypb"google.golang.org/genproto/googleapis/cloud/deploy/v1")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&deploypb.DeleteDeliveryPipelineRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/deploy/v1#DeleteDeliveryPipelineRequest.}op,err:=c.DeleteDeliveryPipeline(ctx,req)iferr!=nil{// TODO: Handle error.}err=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}}func (*CloudDeployClient) DeleteDeliveryPipelineOperation
func(c*CloudDeployClient)DeleteDeliveryPipelineOperation(namestring)*DeleteDeliveryPipelineOperationDeleteDeliveryPipelineOperation returns a new DeleteDeliveryPipelineOperation from a given name.The name must be that of a previously created DeleteDeliveryPipelineOperation, possibly from a different process.
func (*CloudDeployClient) DeleteOperation
func(c*CloudDeployClient)DeleteOperation(ctxcontext.Context,req*longrunningpb.DeleteOperationRequest,opts...gax.CallOption)errorDeleteOperation is a utility method from google.longrunning.Operations.
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1"longrunningpb"google.golang.org/genproto/googleapis/longrunning")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&longrunningpb.DeleteOperationRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/longrunning#DeleteOperationRequest.}err=c.DeleteOperation(ctx,req)iferr!=nil{// TODO: Handle error.}}func (*CloudDeployClient) DeleteTarget
func(c*CloudDeployClient)DeleteTarget(ctxcontext.Context,req*deploypb.DeleteTargetRequest,opts...gax.CallOption)(*DeleteTargetOperation,error)DeleteTarget deletes a single Target.
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1"deploypb"google.golang.org/genproto/googleapis/cloud/deploy/v1")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&deploypb.DeleteTargetRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/deploy/v1#DeleteTargetRequest.}op,err:=c.DeleteTarget(ctx,req)iferr!=nil{// TODO: Handle error.}err=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}}func (*CloudDeployClient) DeleteTargetOperation
func(c*CloudDeployClient)DeleteTargetOperation(namestring)*DeleteTargetOperationDeleteTargetOperation returns a new DeleteTargetOperation from a given name.The name must be that of a previously created DeleteTargetOperation, possibly from a different process.
func (*CloudDeployClient) GetConfig
func(c*CloudDeployClient)GetConfig(ctxcontext.Context,req*deploypb.GetConfigRequest,opts...gax.CallOption)(*deploypb.Config,error)GetConfig gets the configuration for a location.
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1"deploypb"google.golang.org/genproto/googleapis/cloud/deploy/v1")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&deploypb.GetConfigRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/deploy/v1#GetConfigRequest.}resp,err:=c.GetConfig(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*CloudDeployClient) GetDeliveryPipeline
func(c*CloudDeployClient)GetDeliveryPipeline(ctxcontext.Context,req*deploypb.GetDeliveryPipelineRequest,opts...gax.CallOption)(*deploypb.DeliveryPipeline,error)GetDeliveryPipeline gets details of a single DeliveryPipeline.
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1"deploypb"google.golang.org/genproto/googleapis/cloud/deploy/v1")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&deploypb.GetDeliveryPipelineRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/deploy/v1#GetDeliveryPipelineRequest.}resp,err:=c.GetDeliveryPipeline(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*CloudDeployClient) GetIamPolicy
func(c*CloudDeployClient)GetIamPolicy(ctxcontext.Context,req*iampb.GetIamPolicyRequest,opts...gax.CallOption)(*iampb.Policy,error)GetIamPolicy gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1"iampb"google.golang.org/genproto/googleapis/iam/v1")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&iampb.GetIamPolicyRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/iam/v1#GetIamPolicyRequest.}resp,err:=c.GetIamPolicy(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*CloudDeployClient) GetJobRun
func(c*CloudDeployClient)GetJobRun(ctxcontext.Context,req*deploypb.GetJobRunRequest,opts...gax.CallOption)(*deploypb.JobRun,error)GetJobRun gets details of a single JobRun.
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1"deploypb"google.golang.org/genproto/googleapis/cloud/deploy/v1")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&deploypb.GetJobRunRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/deploy/v1#GetJobRunRequest.}resp,err:=c.GetJobRun(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*CloudDeployClient) GetLocation
func(c*CloudDeployClient)GetLocation(ctxcontext.Context,req*locationpb.GetLocationRequest,opts...gax.CallOption)(*locationpb.Location,error)GetLocation gets information about a location.
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1"locationpb"google.golang.org/genproto/googleapis/cloud/location")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.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)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*CloudDeployClient) GetOperation
func(c*CloudDeployClient)GetOperation(ctxcontext.Context,req*longrunningpb.GetOperationRequest,opts...gax.CallOption)(*longrunningpb.Operation,error)GetOperation is a utility method from google.longrunning.Operations.
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1"longrunningpb"google.golang.org/genproto/googleapis/longrunning")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&longrunningpb.GetOperationRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/longrunning#GetOperationRequest.}resp,err:=c.GetOperation(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*CloudDeployClient) GetRelease
func(c*CloudDeployClient)GetRelease(ctxcontext.Context,req*deploypb.GetReleaseRequest,opts...gax.CallOption)(*deploypb.Release,error)GetRelease gets details of a single Release.
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1"deploypb"google.golang.org/genproto/googleapis/cloud/deploy/v1")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&deploypb.GetReleaseRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/deploy/v1#GetReleaseRequest.}resp,err:=c.GetRelease(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*CloudDeployClient) GetRollout
func(c*CloudDeployClient)GetRollout(ctxcontext.Context,req*deploypb.GetRolloutRequest,opts...gax.CallOption)(*deploypb.Rollout,error)GetRollout gets details of a single Rollout.
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1"deploypb"google.golang.org/genproto/googleapis/cloud/deploy/v1")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&deploypb.GetRolloutRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/deploy/v1#GetRolloutRequest.}resp,err:=c.GetRollout(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*CloudDeployClient) GetTarget
func(c*CloudDeployClient)GetTarget(ctxcontext.Context,req*deploypb.GetTargetRequest,opts...gax.CallOption)(*deploypb.Target,error)GetTarget gets details of a single Target.
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1"deploypb"google.golang.org/genproto/googleapis/cloud/deploy/v1")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&deploypb.GetTargetRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/deploy/v1#GetTargetRequest.}resp,err:=c.GetTarget(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*CloudDeployClient) ListDeliveryPipelines
func(c*CloudDeployClient)ListDeliveryPipelines(ctxcontext.Context,req*deploypb.ListDeliveryPipelinesRequest,opts...gax.CallOption)*DeliveryPipelineIteratorListDeliveryPipelines lists DeliveryPipelines in a given project and location.
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1""google.golang.org/api/iterator"deploypb"google.golang.org/genproto/googleapis/cloud/deploy/v1")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&deploypb.ListDeliveryPipelinesRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/deploy/v1#ListDeliveryPipelinesRequest.}it:=c.ListDeliveryPipelines(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}}func (*CloudDeployClient) ListJobRuns
func(c*CloudDeployClient)ListJobRuns(ctxcontext.Context,req*deploypb.ListJobRunsRequest,opts...gax.CallOption)*JobRunIteratorListJobRuns lists JobRuns in a given project and location.
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1""google.golang.org/api/iterator"deploypb"google.golang.org/genproto/googleapis/cloud/deploy/v1")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&deploypb.ListJobRunsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/deploy/v1#ListJobRunsRequest.}it:=c.ListJobRuns(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}}func (*CloudDeployClient) ListLocations
func(c*CloudDeployClient)ListLocations(ctxcontext.Context,req*locationpb.ListLocationsRequest,opts...gax.CallOption)*LocationIteratorListLocations lists information about the supported locations for this service.
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1""google.golang.org/api/iterator"locationpb"google.golang.org/genproto/googleapis/cloud/location")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.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()iferr==iterator.Done{break}iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}}func (*CloudDeployClient) ListOperations
func(c*CloudDeployClient)ListOperations(ctxcontext.Context,req*longrunningpb.ListOperationsRequest,opts...gax.CallOption)*OperationIteratorListOperations is a utility method from google.longrunning.Operations.
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1""google.golang.org/api/iterator"longrunningpb"google.golang.org/genproto/googleapis/longrunning")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&longrunningpb.ListOperationsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/longrunning#ListOperationsRequest.}it:=c.ListOperations(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}}func (*CloudDeployClient) ListReleases
func(c*CloudDeployClient)ListReleases(ctxcontext.Context,req*deploypb.ListReleasesRequest,opts...gax.CallOption)*ReleaseIteratorListReleases lists Releases in a given project and location.
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1""google.golang.org/api/iterator"deploypb"google.golang.org/genproto/googleapis/cloud/deploy/v1")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&deploypb.ListReleasesRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/deploy/v1#ListReleasesRequest.}it:=c.ListReleases(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}}func (*CloudDeployClient) ListRollouts
func(c*CloudDeployClient)ListRollouts(ctxcontext.Context,req*deploypb.ListRolloutsRequest,opts...gax.CallOption)*RolloutIteratorListRollouts lists Rollouts in a given project and location.
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1""google.golang.org/api/iterator"deploypb"google.golang.org/genproto/googleapis/cloud/deploy/v1")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&deploypb.ListRolloutsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/deploy/v1#ListRolloutsRequest.}it:=c.ListRollouts(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}}func (*CloudDeployClient) ListTargets
func(c*CloudDeployClient)ListTargets(ctxcontext.Context,req*deploypb.ListTargetsRequest,opts...gax.CallOption)*TargetIteratorListTargets lists Targets in a given project and location.
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1""google.golang.org/api/iterator"deploypb"google.golang.org/genproto/googleapis/cloud/deploy/v1")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&deploypb.ListTargetsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/deploy/v1#ListTargetsRequest.}it:=c.ListTargets(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}}func (*CloudDeployClient) RetryJob
func(c*CloudDeployClient)RetryJob(ctxcontext.Context,req*deploypb.RetryJobRequest,opts...gax.CallOption)(*deploypb.RetryJobResponse,error)RetryJob retries the specified Job in a Rollout.
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1"deploypb"google.golang.org/genproto/googleapis/cloud/deploy/v1")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&deploypb.RetryJobRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/deploy/v1#RetryJobRequest.}resp,err:=c.RetryJob(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*CloudDeployClient) SetIamPolicy
func(c*CloudDeployClient)SetIamPolicy(ctxcontext.Context,req*iampb.SetIamPolicyRequest,opts...gax.CallOption)(*iampb.Policy,error)SetIamPolicy sets the access control policy on the specified resource. Replacesany existing policy.
Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1"iampb"google.golang.org/genproto/googleapis/iam/v1")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&iampb.SetIamPolicyRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/iam/v1#SetIamPolicyRequest.}resp,err:=c.SetIamPolicy(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*CloudDeployClient) TestIamPermissions
func(c*CloudDeployClient)TestIamPermissions(ctxcontext.Context,req*iampb.TestIamPermissionsRequest,opts...gax.CallOption)(*iampb.TestIamPermissionsResponse,error)TestIamPermissions returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.
Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may “fail open” without warning.
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1"iampb"google.golang.org/genproto/googleapis/iam/v1")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&iampb.TestIamPermissionsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/iam/v1#TestIamPermissionsRequest.}resp,err:=c.TestIamPermissions(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*CloudDeployClient) UpdateDeliveryPipeline
func(c*CloudDeployClient)UpdateDeliveryPipeline(ctxcontext.Context,req*deploypb.UpdateDeliveryPipelineRequest,opts...gax.CallOption)(*UpdateDeliveryPipelineOperation,error)UpdateDeliveryPipeline updates the parameters of a single DeliveryPipeline.
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1"deploypb"google.golang.org/genproto/googleapis/cloud/deploy/v1")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&deploypb.UpdateDeliveryPipelineRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/deploy/v1#UpdateDeliveryPipelineRequest.}op,err:=c.UpdateDeliveryPipeline(ctx,req)iferr!=nil{// TODO: Handle error.}resp,err:=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*CloudDeployClient) UpdateDeliveryPipelineOperation
func(c*CloudDeployClient)UpdateDeliveryPipelineOperation(namestring)*UpdateDeliveryPipelineOperationUpdateDeliveryPipelineOperation returns a new UpdateDeliveryPipelineOperation from a given name.The name must be that of a previously created UpdateDeliveryPipelineOperation, possibly from a different process.
func (*CloudDeployClient) UpdateTarget
func(c*CloudDeployClient)UpdateTarget(ctxcontext.Context,req*deploypb.UpdateTargetRequest,opts...gax.CallOption)(*UpdateTargetOperation,error)UpdateTarget updates the parameters of a single Target.
Example
packagemainimport("context"deploy"cloud.google.com/go/deploy/apiv1"deploypb"google.golang.org/genproto/googleapis/cloud/deploy/v1")funcmain(){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_Optionsc,err:=deploy.NewCloudDeployClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&deploypb.UpdateTargetRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/deploy/v1#UpdateTargetRequest.}op,err:=c.UpdateTarget(ctx,req)iferr!=nil{// TODO: Handle error.}resp,err:=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*CloudDeployClient) UpdateTargetOperation
func(c*CloudDeployClient)UpdateTargetOperation(namestring)*UpdateTargetOperationUpdateTargetOperation returns a new UpdateTargetOperation from a given name.The name must be that of a previously created UpdateTargetOperation, possibly from a different process.
CreateDeliveryPipelineOperation
typeCreateDeliveryPipelineOperationstruct{// contains filtered or unexported fields}CreateDeliveryPipelineOperation manages a long-running operation from CreateDeliveryPipeline.
func (*CreateDeliveryPipelineOperation) Done
func(op*CreateDeliveryPipelineOperation)Done()boolDone reports whether the long-running operation has completed.
func (*CreateDeliveryPipelineOperation) Metadata
func(op*CreateDeliveryPipelineOperation)Metadata()(*deploypb.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 (*CreateDeliveryPipelineOperation) Name
func(op*CreateDeliveryPipelineOperation)Name()stringName 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 (*CreateDeliveryPipelineOperation) Poll
func(op*CreateDeliveryPipelineOperation)Poll(ctxcontext.Context,opts...gax.CallOption)(*deploypb.DeliveryPipeline,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 andthe 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 (*CreateDeliveryPipelineOperation) Wait
func(op*CreateDeliveryPipelineOperation)Wait(ctxcontext.Context,opts...gax.CallOption)(*deploypb.DeliveryPipeline,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.
CreateReleaseOperation
typeCreateReleaseOperationstruct{// contains filtered or unexported fields}CreateReleaseOperation manages a long-running operation from CreateRelease.
func (*CreateReleaseOperation) Done
func(op*CreateReleaseOperation)Done()boolDone reports whether the long-running operation has completed.
func (*CreateReleaseOperation) Metadata
func(op*CreateReleaseOperation)Metadata()(*deploypb.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 (*CreateReleaseOperation) Name
func(op*CreateReleaseOperation)Name()stringName 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 (*CreateReleaseOperation) Poll
func(op*CreateReleaseOperation)Poll(ctxcontext.Context,opts...gax.CallOption)(*deploypb.Release,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 andthe 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 (*CreateReleaseOperation) Wait
func(op*CreateReleaseOperation)Wait(ctxcontext.Context,opts...gax.CallOption)(*deploypb.Release,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.
CreateRolloutOperation
typeCreateRolloutOperationstruct{// contains filtered or unexported fields}CreateRolloutOperation manages a long-running operation from CreateRollout.
func (*CreateRolloutOperation) Done
func(op*CreateRolloutOperation)Done()boolDone reports whether the long-running operation has completed.
func (*CreateRolloutOperation) Metadata
func(op*CreateRolloutOperation)Metadata()(*deploypb.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 (*CreateRolloutOperation) Name
func(op*CreateRolloutOperation)Name()stringName 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 (*CreateRolloutOperation) Poll
func(op*CreateRolloutOperation)Poll(ctxcontext.Context,opts...gax.CallOption)(*deploypb.Rollout,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 andthe 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 (*CreateRolloutOperation) Wait
func(op*CreateRolloutOperation)Wait(ctxcontext.Context,opts...gax.CallOption)(*deploypb.Rollout,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.
CreateTargetOperation
typeCreateTargetOperationstruct{// contains filtered or unexported fields}CreateTargetOperation manages a long-running operation from CreateTarget.
func (*CreateTargetOperation) Done
func(op*CreateTargetOperation)Done()boolDone reports whether the long-running operation has completed.
func (*CreateTargetOperation) Metadata
func(op*CreateTargetOperation)Metadata()(*deploypb.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 (*CreateTargetOperation) Name
func(op*CreateTargetOperation)Name()stringName 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 (*CreateTargetOperation) Poll
func(op*CreateTargetOperation)Poll(ctxcontext.Context,opts...gax.CallOption)(*deploypb.Target,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 andthe 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 (*CreateTargetOperation) Wait
func(op*CreateTargetOperation)Wait(ctxcontext.Context,opts...gax.CallOption)(*deploypb.Target,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.
DeleteDeliveryPipelineOperation
typeDeleteDeliveryPipelineOperationstruct{// contains filtered or unexported fields}DeleteDeliveryPipelineOperation manages a long-running operation from DeleteDeliveryPipeline.
func (*DeleteDeliveryPipelineOperation) Done
func(op*DeleteDeliveryPipelineOperation)Done()boolDone reports whether the long-running operation has completed.
func (*DeleteDeliveryPipelineOperation) Metadata
func(op*DeleteDeliveryPipelineOperation)Metadata()(*deploypb.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 (*DeleteDeliveryPipelineOperation) Name
func(op*DeleteDeliveryPipelineOperation)Name()stringName 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 (*DeleteDeliveryPipelineOperation) Poll
func(op*DeleteDeliveryPipelineOperation)Poll(ctxcontext.Context,opts...gax.CallOption)errorPoll 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 andthe 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 (*DeleteDeliveryPipelineOperation) Wait
func(op*DeleteDeliveryPipelineOperation)Wait(ctxcontext.Context,opts...gax.CallOption)errorWait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
DeleteTargetOperation
typeDeleteTargetOperationstruct{// contains filtered or unexported fields}DeleteTargetOperation manages a long-running operation from DeleteTarget.
func (*DeleteTargetOperation) Done
func(op*DeleteTargetOperation)Done()boolDone reports whether the long-running operation has completed.
func (*DeleteTargetOperation) Metadata
func(op*DeleteTargetOperation)Metadata()(*deploypb.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 (*DeleteTargetOperation) Name
func(op*DeleteTargetOperation)Name()stringName 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 (*DeleteTargetOperation) Poll
func(op*DeleteTargetOperation)Poll(ctxcontext.Context,opts...gax.CallOption)errorPoll 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 andthe 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 (*DeleteTargetOperation) Wait
func(op*DeleteTargetOperation)Wait(ctxcontext.Context,opts...gax.CallOption)errorWait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
DeliveryPipelineIterator
typeDeliveryPipelineIteratorstruct{// 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.Responseinterface{}// 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.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*deploypb.DeliveryPipeline,nextPageTokenstring,errerror)// contains filtered or unexported fields}DeliveryPipelineIterator manages a stream of *deploypb.DeliveryPipeline.
func (*DeliveryPipelineIterator) Next
func(it*DeliveryPipelineIterator)Next()(*deploypb.DeliveryPipeline,error)Next returns the next result. Its second return value is iterator.Done if there are no moreresults. Once Next returns Done, all subsequent calls will return Done.
func (*DeliveryPipelineIterator) PageInfo
func(it*DeliveryPipelineIterator)PageInfo()*iterator.PageInfoPageInfo supports pagination. See the google.golang.org/api/iterator package for details.
JobRunIterator
typeJobRunIteratorstruct{// 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.Responseinterface{}// 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.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*deploypb.JobRun,nextPageTokenstring,errerror)// contains filtered or unexported fields}JobRunIterator manages a stream of *deploypb.JobRun.
func (*JobRunIterator) Next
func(it*JobRunIterator)Next()(*deploypb.JobRun,error)Next returns the next result. Its second return value is iterator.Done if there are no moreresults. Once Next returns Done, all subsequent calls will return Done.
func (*JobRunIterator) PageInfo
func(it*JobRunIterator)PageInfo()*iterator.PageInfoPageInfo supports pagination. See the google.golang.org/api/iterator package for details.
LocationIterator
typeLocationIteratorstruct{// 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.Responseinterface{}// 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.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*locationpb.Location,nextPageTokenstring,errerror)// contains filtered or unexported fields}LocationIterator manages a stream of *locationpb.Location.
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 moreresults. Once Next returns Done, all subsequent calls will return Done.
func (*LocationIterator) PageInfo
func(it*LocationIterator)PageInfo()*iterator.PageInfoPageInfo supports pagination. See the google.golang.org/api/iterator package for details.
OperationIterator
typeOperationIteratorstruct{// 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.Responseinterface{}// 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.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*longrunningpb.Operation,nextPageTokenstring,errerror)// contains filtered or unexported fields}OperationIterator manages a stream of *longrunningpb.Operation.
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 moreresults. Once Next returns Done, all subsequent calls will return Done.
func (*OperationIterator) PageInfo
func(it*OperationIterator)PageInfo()*iterator.PageInfoPageInfo supports pagination. See the google.golang.org/api/iterator package for details.
ReleaseIterator
typeReleaseIteratorstruct{// 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.Responseinterface{}// 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.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*deploypb.Release,nextPageTokenstring,errerror)// contains filtered or unexported fields}ReleaseIterator manages a stream of *deploypb.Release.
func (*ReleaseIterator) Next
func(it*ReleaseIterator)Next()(*deploypb.Release,error)Next returns the next result. Its second return value is iterator.Done if there are no moreresults. Once Next returns Done, all subsequent calls will return Done.
func (*ReleaseIterator) PageInfo
func(it*ReleaseIterator)PageInfo()*iterator.PageInfoPageInfo supports pagination. See the google.golang.org/api/iterator package for details.
RolloutIterator
typeRolloutIteratorstruct{// 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.Responseinterface{}// 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.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*deploypb.Rollout,nextPageTokenstring,errerror)// contains filtered or unexported fields}RolloutIterator manages a stream of *deploypb.Rollout.
func (*RolloutIterator) Next
func(it*RolloutIterator)Next()(*deploypb.Rollout,error)Next returns the next result. Its second return value is iterator.Done if there are no moreresults. Once Next returns Done, all subsequent calls will return Done.
func (*RolloutIterator) PageInfo
func(it*RolloutIterator)PageInfo()*iterator.PageInfoPageInfo supports pagination. See the google.golang.org/api/iterator package for details.
TargetIterator
typeTargetIteratorstruct{// 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.Responseinterface{}// 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.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*deploypb.Target,nextPageTokenstring,errerror)// contains filtered or unexported fields}TargetIterator manages a stream of *deploypb.Target.
func (*TargetIterator) Next
func(it*TargetIterator)Next()(*deploypb.Target,error)Next returns the next result. Its second return value is iterator.Done if there are no moreresults. Once Next returns Done, all subsequent calls will return Done.
func (*TargetIterator) PageInfo
func(it*TargetIterator)PageInfo()*iterator.PageInfoPageInfo supports pagination. See the google.golang.org/api/iterator package for details.
UpdateDeliveryPipelineOperation
typeUpdateDeliveryPipelineOperationstruct{// contains filtered or unexported fields}UpdateDeliveryPipelineOperation manages a long-running operation from UpdateDeliveryPipeline.
func (*UpdateDeliveryPipelineOperation) Done
func(op*UpdateDeliveryPipelineOperation)Done()boolDone reports whether the long-running operation has completed.
func (*UpdateDeliveryPipelineOperation) Metadata
func(op*UpdateDeliveryPipelineOperation)Metadata()(*deploypb.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 (*UpdateDeliveryPipelineOperation) Name
func(op*UpdateDeliveryPipelineOperation)Name()stringName 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 (*UpdateDeliveryPipelineOperation) Poll
func(op*UpdateDeliveryPipelineOperation)Poll(ctxcontext.Context,opts...gax.CallOption)(*deploypb.DeliveryPipeline,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 andthe 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 (*UpdateDeliveryPipelineOperation) Wait
func(op*UpdateDeliveryPipelineOperation)Wait(ctxcontext.Context,opts...gax.CallOption)(*deploypb.DeliveryPipeline,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.
UpdateTargetOperation
typeUpdateTargetOperationstruct{// contains filtered or unexported fields}UpdateTargetOperation manages a long-running operation from UpdateTarget.
func (*UpdateTargetOperation) Done
func(op*UpdateTargetOperation)Done()boolDone reports whether the long-running operation has completed.
func (*UpdateTargetOperation) Metadata
func(op*UpdateTargetOperation)Metadata()(*deploypb.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 (*UpdateTargetOperation) Name
func(op*UpdateTargetOperation)Name()stringName 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 (*UpdateTargetOperation) Poll
func(op*UpdateTargetOperation)Poll(ctxcontext.Context,opts...gax.CallOption)(*deploypb.Target,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 andthe 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 (*UpdateTargetOperation) Wait
func(op*UpdateTargetOperation)Wait(ctxcontext.Context,opts...gax.CallOption)(*deploypb.Target,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.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.