Package deploy is an auto-generated package for the Cloud Deploy API.
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/deploy/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 := deploy . NewCloudDeployClient ( 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 := & deploypb . AbandonReleaseRequest { // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#AbandonReleaseRequest. } resp , err := c . AbandonRelease ( ctx , req ) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp
Use of Context
The ctx passed to NewCloudDeployClient 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.
Functions
func DefaultAuthScopes
func
DefaultAuthScopes
()
[]
string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
AutomationIterator
type
AutomationIterator
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
[]
*
deploypb
.
Automation
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
AutomationIterator manages a stream of *deploypb.Automation.
func (*AutomationIterator) All
func
(
it
*
AutomationIterator
)
All
()
iter
.
Seq2
[
*
deploypb
.
Automation
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*AutomationIterator) Next
func
(
it
*
AutomationIterator
)
Next
()
(
*
deploypb
.
Automation
,
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 (*AutomationIterator) PageInfo
func
(
it
*
AutomationIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
AutomationRunIterator
type
AutomationRunIterator
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
[]
*
deploypb
.
AutomationRun
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
AutomationRunIterator manages a stream of *deploypb.AutomationRun.
func (*AutomationRunIterator) All
func
(
it
*
AutomationRunIterator
)
All
()
iter
.
Seq2
[
*
deploypb
.
AutomationRun
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*AutomationRunIterator) Next
func
(
it
*
AutomationRunIterator
)
Next
()
(
*
deploypb
.
AutomationRun
,
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 (*AutomationRunIterator) PageInfo
func
(
it
*
AutomationRunIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
CloudDeployCallOptions
type
CloudDeployCallOptions
struct
{
ListDeliveryPipelines
[]
gax
.
CallOption
GetDeliveryPipeline
[]
gax
.
CallOption
CreateDeliveryPipeline
[]
gax
.
CallOption
UpdateDeliveryPipeline
[]
gax
.
CallOption
DeleteDeliveryPipeline
[]
gax
.
CallOption
ListTargets
[]
gax
.
CallOption
RollbackTarget
[]
gax
.
CallOption
GetTarget
[]
gax
.
CallOption
CreateTarget
[]
gax
.
CallOption
UpdateTarget
[]
gax
.
CallOption
DeleteTarget
[]
gax
.
CallOption
ListCustomTargetTypes
[]
gax
.
CallOption
GetCustomTargetType
[]
gax
.
CallOption
CreateCustomTargetType
[]
gax
.
CallOption
UpdateCustomTargetType
[]
gax
.
CallOption
DeleteCustomTargetType
[]
gax
.
CallOption
ListReleases
[]
gax
.
CallOption
GetRelease
[]
gax
.
CallOption
CreateRelease
[]
gax
.
CallOption
AbandonRelease
[]
gax
.
CallOption
CreateDeployPolicy
[]
gax
.
CallOption
UpdateDeployPolicy
[]
gax
.
CallOption
DeleteDeployPolicy
[]
gax
.
CallOption
ListDeployPolicies
[]
gax
.
CallOption
GetDeployPolicy
[]
gax
.
CallOption
ApproveRollout
[]
gax
.
CallOption
AdvanceRollout
[]
gax
.
CallOption
CancelRollout
[]
gax
.
CallOption
ListRollouts
[]
gax
.
CallOption
GetRollout
[]
gax
.
CallOption
CreateRollout
[]
gax
.
CallOption
IgnoreJob
[]
gax
.
CallOption
RetryJob
[]
gax
.
CallOption
ListJobRuns
[]
gax
.
CallOption
GetJobRun
[]
gax
.
CallOption
TerminateJobRun
[]
gax
.
CallOption
GetConfig
[]
gax
.
CallOption
CreateAutomation
[]
gax
.
CallOption
UpdateAutomation
[]
gax
.
CallOption
DeleteAutomation
[]
gax
.
CallOption
GetAutomation
[]
gax
.
CallOption
ListAutomations
[]
gax
.
CallOption
GetAutomationRun
[]
gax
.
CallOption
ListAutomationRuns
[]
gax
.
CallOption
CancelAutomationRun
[]
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
}
CloudDeployCallOptions contains the retry settings for each method of CloudDeployClient.
CloudDeployClient
type
CloudDeployClient
struct
{
// 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 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 operations on Google Cloud Platform via Skaffold ( https://skaffold.dev (at https://skaffold.dev )).
func NewCloudDeployClient
func
NewCloudDeployClient
(
ctx
context
.
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 operations on Google Cloud Platform via Skaffold ( https://skaffold.dev (at https://skaffold.dev )).
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func NewCloudDeployRESTClient
func
NewCloudDeployRESTClient
(
ctx
context
.
Context
,
opts
...
option
.
ClientOption
)
(
*
CloudDeployClient
,
error
)
NewCloudDeployRESTClient creates a new cloud deploy rest client.
CloudDeploy service creates and manages Continuous Delivery operations on Google Cloud Platform via Skaffold ( https://skaffold.dev (at https://skaffold.dev )).
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/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
:=
deploy
.
NewCloudDeployRESTClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func (*CloudDeployClient) AbandonRelease
func
(
c
*
CloudDeployClient
)
AbandonRelease
(
ctx
context
.
Context
,
req
*
deploypb
.
AbandonReleaseRequest
,
opts
...
gax
.
CallOption
)
(
*
deploypb
.
AbandonReleaseResponse
,
error
)
AbandonRelease abandons a Release in the Delivery Pipeline.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
AbandonReleaseRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#AbandonReleaseRequest.
}
resp
,
err
:=
c
.
AbandonRelease
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudDeployClient) AdvanceRollout
func
(
c
*
CloudDeployClient
)
AdvanceRollout
(
ctx
context
.
Context
,
req
*
deploypb
.
AdvanceRolloutRequest
,
opts
...
gax
.
CallOption
)
(
*
deploypb
.
AdvanceRolloutResponse
,
error
)
AdvanceRollout advances a Rollout in a given project and location.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
AdvanceRolloutRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#AdvanceRolloutRequest.
}
resp
,
err
:=
c
.
AdvanceRollout
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudDeployClient) ApproveRollout
func
(
c
*
CloudDeployClient
)
ApproveRollout
(
ctx
context
.
Context
,
req
*
deploypb
.
ApproveRolloutRequest
,
opts
...
gax
.
CallOption
)
(
*
deploypb
.
ApproveRolloutResponse
,
error
)
ApproveRollout approves a Rollout.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
ApproveRolloutRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#ApproveRolloutRequest.
}
resp
,
err
:=
c
.
ApproveRollout
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudDeployClient) CancelAutomationRun
func
(
c
*
CloudDeployClient
)
CancelAutomationRun
(
ctx
context
.
Context
,
req
*
deploypb
.
CancelAutomationRunRequest
,
opts
...
gax
.
CallOption
)
(
*
deploypb
.
CancelAutomationRunResponse
,
error
)
CancelAutomationRun cancels an AutomationRun. The state of the AutomationRun after cancelling is CANCELLED. CancelAutomationRun can be called on AutomationRun in the state IN_PROGRESS and PENDING; AutomationRun in a different state returns an FAILED_PRECONDITION error.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
CancelAutomationRunRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#CancelAutomationRunRequest.
}
resp
,
err
:=
c
.
CancelAutomationRun
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudDeployClient) CancelOperation
func
(
c
*
CloudDeployClient
)
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"
deploy
"cloud.google.com/go/deploy/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
:=
deploy
.
NewCloudDeployClient
(
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.
}
}
func (*CloudDeployClient) CancelRollout
func
(
c
*
CloudDeployClient
)
CancelRollout
(
ctx
context
.
Context
,
req
*
deploypb
.
CancelRolloutRequest
,
opts
...
gax
.
CallOption
)
(
*
deploypb
.
CancelRolloutResponse
,
error
)
CancelRollout cancels a Rollout in a given project and location.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
CancelRolloutRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#CancelRolloutRequest.
}
resp
,
err
:=
c
.
CancelRollout
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudDeployClient) Close
func
(
c
*
CloudDeployClient
)
Close
()
error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*CloudDeployClient) Connection (deprecated)
func
(
c
*
CloudDeployClient
)
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 (*CloudDeployClient) CreateAutomation
func
(
c
*
CloudDeployClient
)
CreateAutomation
(
ctx
context
.
Context
,
req
*
deploypb
.
CreateAutomationRequest
,
opts
...
gax
.
CallOption
)
(
*
CreateAutomationOperation
,
error
)
CreateAutomation creates a new Automation in a given project and location.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
CreateAutomationRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#CreateAutomationRequest.
}
op
,
err
:=
c
.
CreateAutomation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudDeployClient) CreateAutomationOperation
func
(
c
*
CloudDeployClient
)
CreateAutomationOperation
(
name
string
)
*
CreateAutomationOperation
CreateAutomationOperation returns a new CreateAutomationOperation from a given name. The name must be that of a previously created CreateAutomationOperation, possibly from a different process.
func (*CloudDeployClient) CreateCustomTargetType
func
(
c
*
CloudDeployClient
)
CreateCustomTargetType
(
ctx
context
.
Context
,
req
*
deploypb
.
CreateCustomTargetTypeRequest
,
opts
...
gax
.
CallOption
)
(
*
CreateCustomTargetTypeOperation
,
error
)
CreateCustomTargetType creates a new CustomTargetType in a given project and location.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
CreateCustomTargetTypeRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#CreateCustomTargetTypeRequest.
}
op
,
err
:=
c
.
CreateCustomTargetType
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudDeployClient) CreateCustomTargetTypeOperation
func
(
c
*
CloudDeployClient
)
CreateCustomTargetTypeOperation
(
name
string
)
*
CreateCustomTargetTypeOperation
CreateCustomTargetTypeOperation returns a new CreateCustomTargetTypeOperation from a given name. The name must be that of a previously created CreateCustomTargetTypeOperation, possibly from a different process.
func (*CloudDeployClient) CreateDeliveryPipeline
func
(
c
*
CloudDeployClient
)
CreateDeliveryPipeline
(
ctx
context
.
Context
,
req
*
deploypb
.
CreateDeliveryPipelineRequest
,
opts
...
gax
.
CallOption
)
(
*
CreateDeliveryPipelineOperation
,
error
)
CreateDeliveryPipeline creates a new DeliveryPipeline in a given project and location.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
CreateDeliveryPipelineRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#CreateDeliveryPipelineRequest.
}
op
,
err
:=
c
.
CreateDeliveryPipeline
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudDeployClient) CreateDeliveryPipelineOperation
func
(
c
*
CloudDeployClient
)
CreateDeliveryPipelineOperation
(
name
string
)
*
CreateDeliveryPipelineOperation
CreateDeliveryPipelineOperation 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) CreateDeployPolicy
func
(
c
*
CloudDeployClient
)
CreateDeployPolicy
(
ctx
context
.
Context
,
req
*
deploypb
.
CreateDeployPolicyRequest
,
opts
...
gax
.
CallOption
)
(
*
CreateDeployPolicyOperation
,
error
)
CreateDeployPolicy creates a new DeployPolicy in a given project and location.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
CreateDeployPolicyRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#CreateDeployPolicyRequest.
}
op
,
err
:=
c
.
CreateDeployPolicy
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudDeployClient) CreateDeployPolicyOperation
func
(
c
*
CloudDeployClient
)
CreateDeployPolicyOperation
(
name
string
)
*
CreateDeployPolicyOperation
CreateDeployPolicyOperation returns a new CreateDeployPolicyOperation from a given name. The name must be that of a previously created CreateDeployPolicyOperation, possibly from a different process.
func (*CloudDeployClient) CreateRelease
func
(
c
*
CloudDeployClient
)
CreateRelease
(
ctx
context
.
Context
,
req
*
deploypb
.
CreateReleaseRequest
,
opts
...
gax
.
CallOption
)
(
*
CreateReleaseOperation
,
error
)
CreateRelease creates a new Release in a given project and location.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
CreateReleaseRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#CreateReleaseRequest.
}
op
,
err
:=
c
.
CreateRelease
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudDeployClient) CreateReleaseOperation
func
(
c
*
CloudDeployClient
)
CreateReleaseOperation
(
name
string
)
*
CreateReleaseOperation
CreateReleaseOperation 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
(
ctx
context
.
Context
,
req
*
deploypb
.
CreateRolloutRequest
,
opts
...
gax
.
CallOption
)
(
*
CreateRolloutOperation
,
error
)
CreateRollout creates a new Rollout in a given project and location.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
CreateRolloutRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#CreateRolloutRequest.
}
op
,
err
:=
c
.
CreateRollout
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudDeployClient) CreateRolloutOperation
func
(
c
*
CloudDeployClient
)
CreateRolloutOperation
(
name
string
)
*
CreateRolloutOperation
CreateRolloutOperation 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
(
ctx
context
.
Context
,
req
*
deploypb
.
CreateTargetRequest
,
opts
...
gax
.
CallOption
)
(
*
CreateTargetOperation
,
error
)
CreateTarget creates a new Target in a given project and location.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
CreateTargetRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#CreateTargetRequest.
}
op
,
err
:=
c
.
CreateTarget
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudDeployClient) CreateTargetOperation
func
(
c
*
CloudDeployClient
)
CreateTargetOperation
(
name
string
)
*
CreateTargetOperation
CreateTargetOperation 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) DeleteAutomation
func
(
c
*
CloudDeployClient
)
DeleteAutomation
(
ctx
context
.
Context
,
req
*
deploypb
.
DeleteAutomationRequest
,
opts
...
gax
.
CallOption
)
(
*
DeleteAutomationOperation
,
error
)
DeleteAutomation deletes a single Automation resource.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
DeleteAutomationRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#DeleteAutomationRequest.
}
op
,
err
:=
c
.
DeleteAutomation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
err
=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*CloudDeployClient) DeleteAutomationOperation
func
(
c
*
CloudDeployClient
)
DeleteAutomationOperation
(
name
string
)
*
DeleteAutomationOperation
DeleteAutomationOperation returns a new DeleteAutomationOperation from a given name. The name must be that of a previously created DeleteAutomationOperation, possibly from a different process.
func (*CloudDeployClient) DeleteCustomTargetType
func
(
c
*
CloudDeployClient
)
DeleteCustomTargetType
(
ctx
context
.
Context
,
req
*
deploypb
.
DeleteCustomTargetTypeRequest
,
opts
...
gax
.
CallOption
)
(
*
DeleteCustomTargetTypeOperation
,
error
)
DeleteCustomTargetType deletes a single CustomTargetType.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
DeleteCustomTargetTypeRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#DeleteCustomTargetTypeRequest.
}
op
,
err
:=
c
.
DeleteCustomTargetType
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
err
=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*CloudDeployClient) DeleteCustomTargetTypeOperation
func
(
c
*
CloudDeployClient
)
DeleteCustomTargetTypeOperation
(
name
string
)
*
DeleteCustomTargetTypeOperation
DeleteCustomTargetTypeOperation returns a new DeleteCustomTargetTypeOperation from a given name. The name must be that of a previously created DeleteCustomTargetTypeOperation, possibly from a different process.
func (*CloudDeployClient) DeleteDeliveryPipeline
func
(
c
*
CloudDeployClient
)
DeleteDeliveryPipeline
(
ctx
context
.
Context
,
req
*
deploypb
.
DeleteDeliveryPipelineRequest
,
opts
...
gax
.
CallOption
)
(
*
DeleteDeliveryPipelineOperation
,
error
)
DeleteDeliveryPipeline deletes a single DeliveryPipeline.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
DeleteDeliveryPipelineRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#DeleteDeliveryPipelineRequest.
}
op
,
err
:=
c
.
DeleteDeliveryPipeline
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
err
=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*CloudDeployClient) DeleteDeliveryPipelineOperation
func
(
c
*
CloudDeployClient
)
DeleteDeliveryPipelineOperation
(
name
string
)
*
DeleteDeliveryPipelineOperation
DeleteDeliveryPipelineOperation 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) DeleteDeployPolicy
func
(
c
*
CloudDeployClient
)
DeleteDeployPolicy
(
ctx
context
.
Context
,
req
*
deploypb
.
DeleteDeployPolicyRequest
,
opts
...
gax
.
CallOption
)
(
*
DeleteDeployPolicyOperation
,
error
)
DeleteDeployPolicy deletes a single DeployPolicy.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
DeleteDeployPolicyRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#DeleteDeployPolicyRequest.
}
op
,
err
:=
c
.
DeleteDeployPolicy
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
err
=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*CloudDeployClient) DeleteDeployPolicyOperation
func
(
c
*
CloudDeployClient
)
DeleteDeployPolicyOperation
(
name
string
)
*
DeleteDeployPolicyOperation
DeleteDeployPolicyOperation returns a new DeleteDeployPolicyOperation from a given name. The name must be that of a previously created DeleteDeployPolicyOperation, possibly from a different process.
func (*CloudDeployClient) DeleteOperation
func
(
c
*
CloudDeployClient
)
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"
deploy
"cloud.google.com/go/deploy/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
:=
deploy
.
NewCloudDeployClient
(
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.
}
}
func (*CloudDeployClient) DeleteTarget
func
(
c
*
CloudDeployClient
)
DeleteTarget
(
ctx
context
.
Context
,
req
*
deploypb
.
DeleteTargetRequest
,
opts
...
gax
.
CallOption
)
(
*
DeleteTargetOperation
,
error
)
DeleteTarget deletes a single Target.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
DeleteTargetRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#DeleteTargetRequest.
}
op
,
err
:=
c
.
DeleteTarget
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
err
=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*CloudDeployClient) DeleteTargetOperation
func
(
c
*
CloudDeployClient
)
DeleteTargetOperation
(
name
string
)
*
DeleteTargetOperation
DeleteTargetOperation 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) GetAutomation
func
(
c
*
CloudDeployClient
)
GetAutomation
(
ctx
context
.
Context
,
req
*
deploypb
.
GetAutomationRequest
,
opts
...
gax
.
CallOption
)
(
*
deploypb
.
Automation
,
error
)
GetAutomation gets details of a single Automation.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
GetAutomationRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#GetAutomationRequest.
}
resp
,
err
:=
c
.
GetAutomation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudDeployClient) GetAutomationRun
func
(
c
*
CloudDeployClient
)
GetAutomationRun
(
ctx
context
.
Context
,
req
*
deploypb
.
GetAutomationRunRequest
,
opts
...
gax
.
CallOption
)
(
*
deploypb
.
AutomationRun
,
error
)
GetAutomationRun gets details of a single AutomationRun.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
GetAutomationRunRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#GetAutomationRunRequest.
}
resp
,
err
:=
c
.
GetAutomationRun
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudDeployClient) GetConfig
func
(
c
*
CloudDeployClient
)
GetConfig
(
ctx
context
.
Context
,
req
*
deploypb
.
GetConfigRequest
,
opts
...
gax
.
CallOption
)
(
*
deploypb
.
Config
,
error
)
GetConfig gets the configuration for a location.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
GetConfigRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#GetConfigRequest.
}
resp
,
err
:=
c
.
GetConfig
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudDeployClient) GetCustomTargetType
func
(
c
*
CloudDeployClient
)
GetCustomTargetType
(
ctx
context
.
Context
,
req
*
deploypb
.
GetCustomTargetTypeRequest
,
opts
...
gax
.
CallOption
)
(
*
deploypb
.
CustomTargetType
,
error
)
GetCustomTargetType gets details of a single CustomTargetType.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
GetCustomTargetTypeRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#GetCustomTargetTypeRequest.
}
resp
,
err
:=
c
.
GetCustomTargetType
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudDeployClient) GetDeliveryPipeline
func
(
c
*
CloudDeployClient
)
GetDeliveryPipeline
(
ctx
context
.
Context
,
req
*
deploypb
.
GetDeliveryPipelineRequest
,
opts
...
gax
.
CallOption
)
(
*
deploypb
.
DeliveryPipeline
,
error
)
GetDeliveryPipeline gets details of a single DeliveryPipeline.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
GetDeliveryPipelineRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#GetDeliveryPipelineRequest.
}
resp
,
err
:=
c
.
GetDeliveryPipeline
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudDeployClient) GetDeployPolicy
func
(
c
*
CloudDeployClient
)
GetDeployPolicy
(
ctx
context
.
Context
,
req
*
deploypb
.
GetDeployPolicyRequest
,
opts
...
gax
.
CallOption
)
(
*
deploypb
.
DeployPolicy
,
error
)
GetDeployPolicy gets details of a single DeployPolicy.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
GetDeployPolicyRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#GetDeployPolicyRequest.
}
resp
,
err
:=
c
.
GetDeployPolicy
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudDeployClient) GetIamPolicy
func
(
c
*
CloudDeployClient
)
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"
deploy
"cloud.google.com/go/deploy/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
:=
deploy
.
NewCloudDeployClient
(
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
}
func (*CloudDeployClient) GetJobRun
func
(
c
*
CloudDeployClient
)
GetJobRun
(
ctx
context
.
Context
,
req
*
deploypb
.
GetJobRunRequest
,
opts
...
gax
.
CallOption
)
(
*
deploypb
.
JobRun
,
error
)
GetJobRun gets details of a single JobRun.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
GetJobRunRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#GetJobRunRequest.
}
resp
,
err
:=
c
.
GetJobRun
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudDeployClient) GetLocation
func
(
c
*
CloudDeployClient
)
GetLocation
(
ctx
context
.
Context
,
req
*
locationpb
.
GetLocationRequest
,
opts
...
gax
.
CallOption
)
(
*
locationpb
.
Location
,
error
)
GetLocation gets information about a location.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/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
:=
deploy
.
NewCloudDeployClient
(
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
}
func (*CloudDeployClient) GetOperation
func
(
c
*
CloudDeployClient
)
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"
deploy
"cloud.google.com/go/deploy/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
:=
deploy
.
NewCloudDeployClient
(
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
}
func (*CloudDeployClient) GetRelease
func
(
c
*
CloudDeployClient
)
GetRelease
(
ctx
context
.
Context
,
req
*
deploypb
.
GetReleaseRequest
,
opts
...
gax
.
CallOption
)
(
*
deploypb
.
Release
,
error
)
GetRelease gets details of a single Release.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
GetReleaseRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#GetReleaseRequest.
}
resp
,
err
:=
c
.
GetRelease
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudDeployClient) GetRollout
func
(
c
*
CloudDeployClient
)
GetRollout
(
ctx
context
.
Context
,
req
*
deploypb
.
GetRolloutRequest
,
opts
...
gax
.
CallOption
)
(
*
deploypb
.
Rollout
,
error
)
GetRollout gets details of a single Rollout.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
GetRolloutRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#GetRolloutRequest.
}
resp
,
err
:=
c
.
GetRollout
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudDeployClient) GetTarget
func
(
c
*
CloudDeployClient
)
GetTarget
(
ctx
context
.
Context
,
req
*
deploypb
.
GetTargetRequest
,
opts
...
gax
.
CallOption
)
(
*
deploypb
.
Target
,
error
)
GetTarget gets details of a single Target.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
GetTargetRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#GetTargetRequest.
}
resp
,
err
:=
c
.
GetTarget
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudDeployClient) IgnoreJob
func
(
c
*
CloudDeployClient
)
IgnoreJob
(
ctx
context
.
Context
,
req
*
deploypb
.
IgnoreJobRequest
,
opts
...
gax
.
CallOption
)
(
*
deploypb
.
IgnoreJobResponse
,
error
)
IgnoreJob ignores the specified Job in a Rollout.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
IgnoreJobRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#IgnoreJobRequest.
}
resp
,
err
:=
c
.
IgnoreJob
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudDeployClient) ListAutomationRuns
func
(
c
*
CloudDeployClient
)
ListAutomationRuns
(
ctx
context
.
Context
,
req
*
deploypb
.
ListAutomationRunsRequest
,
opts
...
gax
.
CallOption
)
*
AutomationRunIterator
ListAutomationRuns lists AutomationRuns in a given project and location.
Examples
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
"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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
ListAutomationRunsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#ListAutomationRunsRequest.
}
it
:=
c
.
ListAutomationRuns
(
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
.(
*
deploypb
.
ListAutomationRunsResponse
)
}
}
all
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
ListAutomationRunsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#ListAutomationRunsRequest.
}
for
resp
,
err
:=
range
c
.
ListAutomationRuns
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*CloudDeployClient) ListAutomations
func
(
c
*
CloudDeployClient
)
ListAutomations
(
ctx
context
.
Context
,
req
*
deploypb
.
ListAutomationsRequest
,
opts
...
gax
.
CallOption
)
*
AutomationIterator
ListAutomations lists Automations in a given project and location.
Examples
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
"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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
ListAutomationsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#ListAutomationsRequest.
}
it
:=
c
.
ListAutomations
(
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
.(
*
deploypb
.
ListAutomationsResponse
)
}
}
all
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
ListAutomationsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#ListAutomationsRequest.
}
for
resp
,
err
:=
range
c
.
ListAutomations
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*CloudDeployClient) ListCustomTargetTypes
func
(
c
*
CloudDeployClient
)
ListCustomTargetTypes
(
ctx
context
.
Context
,
req
*
deploypb
.
ListCustomTargetTypesRequest
,
opts
...
gax
.
CallOption
)
*
CustomTargetTypeIterator
ListCustomTargetTypes lists CustomTargetTypes in a given project and location.
Examples
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
"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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
ListCustomTargetTypesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#ListCustomTargetTypesRequest.
}
it
:=
c
.
ListCustomTargetTypes
(
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
.(
*
deploypb
.
ListCustomTargetTypesResponse
)
}
}
all
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
ListCustomTargetTypesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#ListCustomTargetTypesRequest.
}
for
resp
,
err
:=
range
c
.
ListCustomTargetTypes
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*CloudDeployClient) ListDeliveryPipelines
func
(
c
*
CloudDeployClient
)
ListDeliveryPipelines
(
ctx
context
.
Context
,
req
*
deploypb
.
ListDeliveryPipelinesRequest
,
opts
...
gax
.
CallOption
)
*
DeliveryPipelineIterator
ListDeliveryPipelines lists DeliveryPipelines in a given project and location.
Examples
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
"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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
ListDeliveryPipelinesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#ListDeliveryPipelinesRequest.
}
it
:=
c
.
ListDeliveryPipelines
(
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
.(
*
deploypb
.
ListDeliveryPipelinesResponse
)
}
}
all
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
ListDeliveryPipelinesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#ListDeliveryPipelinesRequest.
}
for
resp
,
err
:=
range
c
.
ListDeliveryPipelines
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*CloudDeployClient) ListDeployPolicies
func
(
c
*
CloudDeployClient
)
ListDeployPolicies
(
ctx
context
.
Context
,
req
*
deploypb
.
ListDeployPoliciesRequest
,
opts
...
gax
.
CallOption
)
*
DeployPolicyIterator
ListDeployPolicies lists DeployPolicies in a given project and location.
Examples
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
"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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
ListDeployPoliciesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#ListDeployPoliciesRequest.
}
it
:=
c
.
ListDeployPolicies
(
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
.(
*
deploypb
.
ListDeployPoliciesResponse
)
}
}
all
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
ListDeployPoliciesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#ListDeployPoliciesRequest.
}
for
resp
,
err
:=
range
c
.
ListDeployPolicies
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*CloudDeployClient) ListJobRuns
func
(
c
*
CloudDeployClient
)
ListJobRuns
(
ctx
context
.
Context
,
req
*
deploypb
.
ListJobRunsRequest
,
opts
...
gax
.
CallOption
)
*
JobRunIterator
ListJobRuns lists JobRuns in a given project and location.
Examples
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
"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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
ListJobRunsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#ListJobRunsRequest.
}
it
:=
c
.
ListJobRuns
(
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
.(
*
deploypb
.
ListJobRunsResponse
)
}
}
all
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
ListJobRunsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#ListJobRunsRequest.
}
for
resp
,
err
:=
range
c
.
ListJobRuns
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*CloudDeployClient) ListLocations
func
(
c
*
CloudDeployClient
)
ListLocations
(
ctx
context
.
Context
,
req
*
locationpb
.
ListLocationsRequest
,
opts
...
gax
.
CallOption
)
*
LocationIterator
ListLocations lists information about the supported locations for this service.
Examples
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/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
:=
deploy
.
NewCloudDeployClient
(
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
)
}
}
all
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/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
:=
deploy
.
NewCloudDeployClient
(
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
}
}
func (*CloudDeployClient) ListOperations
func
(
c
*
CloudDeployClient
)
ListOperations
(
ctx
context
.
Context
,
req
*
longrunningpb
.
ListOperationsRequest
,
opts
...
gax
.
CallOption
)
*
OperationIterator
ListOperations is a utility method from google.longrunning.Operations.
Examples
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/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
:=
deploy
.
NewCloudDeployClient
(
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
)
}
}
all
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/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
:=
deploy
.
NewCloudDeployClient
(
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
}
}
func (*CloudDeployClient) ListReleases
func
(
c
*
CloudDeployClient
)
ListReleases
(
ctx
context
.
Context
,
req
*
deploypb
.
ListReleasesRequest
,
opts
...
gax
.
CallOption
)
*
ReleaseIterator
ListReleases lists Releases in a given project and location.
Examples
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
"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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
ListReleasesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#ListReleasesRequest.
}
it
:=
c
.
ListReleases
(
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
.(
*
deploypb
.
ListReleasesResponse
)
}
}
all
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
ListReleasesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#ListReleasesRequest.
}
for
resp
,
err
:=
range
c
.
ListReleases
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*CloudDeployClient) ListRollouts
func
(
c
*
CloudDeployClient
)
ListRollouts
(
ctx
context
.
Context
,
req
*
deploypb
.
ListRolloutsRequest
,
opts
...
gax
.
CallOption
)
*
RolloutIterator
ListRollouts lists Rollouts in a given project and location.
Examples
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
"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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
ListRolloutsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#ListRolloutsRequest.
}
it
:=
c
.
ListRollouts
(
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
.(
*
deploypb
.
ListRolloutsResponse
)
}
}
all
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
ListRolloutsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#ListRolloutsRequest.
}
for
resp
,
err
:=
range
c
.
ListRollouts
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*CloudDeployClient) ListTargets
func
(
c
*
CloudDeployClient
)
ListTargets
(
ctx
context
.
Context
,
req
*
deploypb
.
ListTargetsRequest
,
opts
...
gax
.
CallOption
)
*
TargetIterator
ListTargets lists Targets in a given project and location.
Examples
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
"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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
ListTargetsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#ListTargetsRequest.
}
it
:=
c
.
ListTargets
(
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
.(
*
deploypb
.
ListTargetsResponse
)
}
}
all
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
ListTargetsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#ListTargetsRequest.
}
for
resp
,
err
:=
range
c
.
ListTargets
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*CloudDeployClient) RetryJob
func
(
c
*
CloudDeployClient
)
RetryJob
(
ctx
context
.
Context
,
req
*
deploypb
.
RetryJobRequest
,
opts
...
gax
.
CallOption
)
(
*
deploypb
.
RetryJobResponse
,
error
)
RetryJob retries the specified Job in a Rollout.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
RetryJobRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#RetryJobRequest.
}
resp
,
err
:=
c
.
RetryJob
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudDeployClient) RollbackTarget
func
(
c
*
CloudDeployClient
)
RollbackTarget
(
ctx
context
.
Context
,
req
*
deploypb
.
RollbackTargetRequest
,
opts
...
gax
.
CallOption
)
(
*
deploypb
.
RollbackTargetResponse
,
error
)
RollbackTarget creates a Rollout to roll back the specified target.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
RollbackTargetRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#RollbackTargetRequest.
}
resp
,
err
:=
c
.
RollbackTarget
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudDeployClient) SetIamPolicy
func
(
c
*
CloudDeployClient
)
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"
deploy
"cloud.google.com/go/deploy/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
:=
deploy
.
NewCloudDeployClient
(
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
}
func (*CloudDeployClient) TerminateJobRun
func
(
c
*
CloudDeployClient
)
TerminateJobRun
(
ctx
context
.
Context
,
req
*
deploypb
.
TerminateJobRunRequest
,
opts
...
gax
.
CallOption
)
(
*
deploypb
.
TerminateJobRunResponse
,
error
)
TerminateJobRun terminates a Job Run in a given project and location.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
TerminateJobRunRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#TerminateJobRunRequest.
}
resp
,
err
:=
c
.
TerminateJobRun
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudDeployClient) TestIamPermissions
func
(
c
*
CloudDeployClient
)
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"
deploy
"cloud.google.com/go/deploy/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
:=
deploy
.
NewCloudDeployClient
(
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
}
func (*CloudDeployClient) UpdateAutomation
func
(
c
*
CloudDeployClient
)
UpdateAutomation
(
ctx
context
.
Context
,
req
*
deploypb
.
UpdateAutomationRequest
,
opts
...
gax
.
CallOption
)
(
*
UpdateAutomationOperation
,
error
)
UpdateAutomation updates the parameters of a single Automation resource.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
UpdateAutomationRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#UpdateAutomationRequest.
}
op
,
err
:=
c
.
UpdateAutomation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudDeployClient) UpdateAutomationOperation
func
(
c
*
CloudDeployClient
)
UpdateAutomationOperation
(
name
string
)
*
UpdateAutomationOperation
UpdateAutomationOperation returns a new UpdateAutomationOperation from a given name. The name must be that of a previously created UpdateAutomationOperation, possibly from a different process.
func (*CloudDeployClient) UpdateCustomTargetType
func
(
c
*
CloudDeployClient
)
UpdateCustomTargetType
(
ctx
context
.
Context
,
req
*
deploypb
.
UpdateCustomTargetTypeRequest
,
opts
...
gax
.
CallOption
)
(
*
UpdateCustomTargetTypeOperation
,
error
)
UpdateCustomTargetType updates a single CustomTargetType.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
UpdateCustomTargetTypeRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#UpdateCustomTargetTypeRequest.
}
op
,
err
:=
c
.
UpdateCustomTargetType
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudDeployClient) UpdateCustomTargetTypeOperation
func
(
c
*
CloudDeployClient
)
UpdateCustomTargetTypeOperation
(
name
string
)
*
UpdateCustomTargetTypeOperation
UpdateCustomTargetTypeOperation returns a new UpdateCustomTargetTypeOperation from a given name. The name must be that of a previously created UpdateCustomTargetTypeOperation, possibly from a different process.
func (*CloudDeployClient) UpdateDeliveryPipeline
func
(
c
*
CloudDeployClient
)
UpdateDeliveryPipeline
(
ctx
context
.
Context
,
req
*
deploypb
.
UpdateDeliveryPipelineRequest
,
opts
...
gax
.
CallOption
)
(
*
UpdateDeliveryPipelineOperation
,
error
)
UpdateDeliveryPipeline updates the parameters of a single DeliveryPipeline.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
UpdateDeliveryPipelineRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#UpdateDeliveryPipelineRequest.
}
op
,
err
:=
c
.
UpdateDeliveryPipeline
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudDeployClient) UpdateDeliveryPipelineOperation
func
(
c
*
CloudDeployClient
)
UpdateDeliveryPipelineOperation
(
name
string
)
*
UpdateDeliveryPipelineOperation
UpdateDeliveryPipelineOperation 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) UpdateDeployPolicy
func
(
c
*
CloudDeployClient
)
UpdateDeployPolicy
(
ctx
context
.
Context
,
req
*
deploypb
.
UpdateDeployPolicyRequest
,
opts
...
gax
.
CallOption
)
(
*
UpdateDeployPolicyOperation
,
error
)
UpdateDeployPolicy updates the parameters of a single DeployPolicy.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
UpdateDeployPolicyRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#UpdateDeployPolicyRequest.
}
op
,
err
:=
c
.
UpdateDeployPolicy
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudDeployClient) UpdateDeployPolicyOperation
func
(
c
*
CloudDeployClient
)
UpdateDeployPolicyOperation
(
name
string
)
*
UpdateDeployPolicyOperation
UpdateDeployPolicyOperation returns a new UpdateDeployPolicyOperation from a given name. The name must be that of a previously created UpdateDeployPolicyOperation, possibly from a different process.
func (*CloudDeployClient) UpdateTarget
func
(
c
*
CloudDeployClient
)
UpdateTarget
(
ctx
context
.
Context
,
req
*
deploypb
.
UpdateTargetRequest
,
opts
...
gax
.
CallOption
)
(
*
UpdateTargetOperation
,
error
)
UpdateTarget updates the parameters of a single Target.
Example
package
main
import
(
"context"
deploy
"cloud.google.com/go/deploy/apiv1"
deploypb
"cloud.google.com/go/deploy/apiv1/deploypb"
)
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
:=
deploy
.
NewCloudDeployClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& deploypb
.
UpdateTargetRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/deploy/apiv1/deploypb#UpdateTargetRequest.
}
op
,
err
:=
c
.
UpdateTarget
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudDeployClient) UpdateTargetOperation
func
(
c
*
CloudDeployClient
)
UpdateTargetOperation
(
name
string
)
*
UpdateTargetOperation
UpdateTargetOperation returns a new UpdateTargetOperation from a given name. The name must be that of a previously created UpdateTargetOperation, possibly from a different process.
CreateAutomationOperation
type
CreateAutomationOperation
struct
{
// contains filtered or unexported fields
}
CreateAutomationOperation manages a long-running operation from CreateAutomation.
func (*CreateAutomationOperation) Done
func
(
op
*
CreateAutomationOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*CreateAutomationOperation) Metadata
func
(
op
*
CreateAutomationOperation
)
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 (*CreateAutomationOperation) Name
func
(
op
*
CreateAutomationOperation
)
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 (*CreateAutomationOperation) Poll
func
(
op
*
CreateAutomationOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
deploypb
.
Automation
,
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 (*CreateAutomationOperation) Wait
func
(
op
*
CreateAutomationOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
deploypb
.
Automation
,
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.
CreateCustomTargetTypeOperation
type
CreateCustomTargetTypeOperation
struct
{
// contains filtered or unexported fields
}
CreateCustomTargetTypeOperation manages a long-running operation from CreateCustomTargetType.
func (*CreateCustomTargetTypeOperation) Done
func
(
op
*
CreateCustomTargetTypeOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*CreateCustomTargetTypeOperation) Metadata
func
(
op
*
CreateCustomTargetTypeOperation
)
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 (*CreateCustomTargetTypeOperation) Name
func
(
op
*
CreateCustomTargetTypeOperation
)
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 (*CreateCustomTargetTypeOperation) Poll
func
(
op
*
CreateCustomTargetTypeOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
deploypb
.
CustomTargetType
,
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 (*CreateCustomTargetTypeOperation) Wait
func
(
op
*
CreateCustomTargetTypeOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
deploypb
.
CustomTargetType
,
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.
CreateDeliveryPipelineOperation
type
CreateDeliveryPipelineOperation
struct
{
// contains filtered or unexported fields
}
CreateDeliveryPipelineOperation manages a long-running operation from CreateDeliveryPipeline.
func (*CreateDeliveryPipelineOperation) Done
func
(
op
*
CreateDeliveryPipelineOperation
)
Done
()
bool
Done 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
()
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 (*CreateDeliveryPipelineOperation) Poll
func
(
op
*
CreateDeliveryPipelineOperation
)
Poll
(
ctx
context
.
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 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 (*CreateDeliveryPipelineOperation) Wait
func
(
op
*
CreateDeliveryPipelineOperation
)
Wait
(
ctx
context
.
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.
CreateDeployPolicyOperation
type
CreateDeployPolicyOperation
struct
{
// contains filtered or unexported fields
}
CreateDeployPolicyOperation manages a long-running operation from CreateDeployPolicy.
func (*CreateDeployPolicyOperation) Done
func
(
op
*
CreateDeployPolicyOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*CreateDeployPolicyOperation) Metadata
func
(
op
*
CreateDeployPolicyOperation
)
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 (*CreateDeployPolicyOperation) Name
func
(
op
*
CreateDeployPolicyOperation
)
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 (*CreateDeployPolicyOperation) Poll
func
(
op
*
CreateDeployPolicyOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
deploypb
.
DeployPolicy
,
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 (*CreateDeployPolicyOperation) Wait
func
(
op
*
CreateDeployPolicyOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
deploypb
.
DeployPolicy
,
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
type
CreateReleaseOperation
struct
{
// contains filtered or unexported fields
}
CreateReleaseOperation manages a long-running operation from CreateRelease.
func (*CreateReleaseOperation) Done
func
(
op
*
CreateReleaseOperation
)
Done
()
bool
Done 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
()
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 (*CreateReleaseOperation) Poll
func
(
op
*
CreateReleaseOperation
)
Poll
(
ctx
context
.
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 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 (*CreateReleaseOperation) Wait
func
(
op
*
CreateReleaseOperation
)
Wait
(
ctx
context
.
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
type
CreateRolloutOperation
struct
{
// contains filtered or unexported fields
}
CreateRolloutOperation manages a long-running operation from CreateRollout.
func (*CreateRolloutOperation) Done
func
(
op
*
CreateRolloutOperation
)
Done
()
bool
Done 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
()
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 (*CreateRolloutOperation) Poll
func
(
op
*
CreateRolloutOperation
)
Poll
(
ctx
context
.
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 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 (*CreateRolloutOperation) Wait
func
(
op
*
CreateRolloutOperation
)
Wait
(
ctx
context
.
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
type
CreateTargetOperation
struct
{
// contains filtered or unexported fields
}
CreateTargetOperation manages a long-running operation from CreateTarget.
func (*CreateTargetOperation) Done
func
(
op
*
CreateTargetOperation
)
Done
()
bool
Done 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
()
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 (*CreateTargetOperation) Poll
func
(
op
*
CreateTargetOperation
)
Poll
(
ctx
context
.
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 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 (*CreateTargetOperation) Wait
func
(
op
*
CreateTargetOperation
)
Wait
(
ctx
context
.
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.
CustomTargetTypeIterator
type
CustomTargetTypeIterator
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
[]
*
deploypb
.
CustomTargetType
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
CustomTargetTypeIterator manages a stream of *deploypb.CustomTargetType.
func (*CustomTargetTypeIterator) All
func
(
it
*
CustomTargetTypeIterator
)
All
()
iter
.
Seq2
[
*
deploypb
.
CustomTargetType
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*CustomTargetTypeIterator) Next
func
(
it
*
CustomTargetTypeIterator
)
Next
()
(
*
deploypb
.
CustomTargetType
,
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 (*CustomTargetTypeIterator) PageInfo
func
(
it
*
CustomTargetTypeIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
DeleteAutomationOperation
type
DeleteAutomationOperation
struct
{
// contains filtered or unexported fields
}
DeleteAutomationOperation manages a long-running operation from DeleteAutomation.
func (*DeleteAutomationOperation) Done
func
(
op
*
DeleteAutomationOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*DeleteAutomationOperation) Metadata
func
(
op
*
DeleteAutomationOperation
)
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 (*DeleteAutomationOperation) Name
func
(
op
*
DeleteAutomationOperation
)
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 (*DeleteAutomationOperation) Poll
func
(
op
*
DeleteAutomationOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteAutomationOperation) Wait
func
(
op
*
DeleteAutomationOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
DeleteCustomTargetTypeOperation
type
DeleteCustomTargetTypeOperation
struct
{
// contains filtered or unexported fields
}
DeleteCustomTargetTypeOperation manages a long-running operation from DeleteCustomTargetType.
func (*DeleteCustomTargetTypeOperation) Done
func
(
op
*
DeleteCustomTargetTypeOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*DeleteCustomTargetTypeOperation) Metadata
func
(
op
*
DeleteCustomTargetTypeOperation
)
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 (*DeleteCustomTargetTypeOperation) Name
func
(
op
*
DeleteCustomTargetTypeOperation
)
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 (*DeleteCustomTargetTypeOperation) Poll
func
(
op
*
DeleteCustomTargetTypeOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteCustomTargetTypeOperation) Wait
func
(
op
*
DeleteCustomTargetTypeOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
DeleteDeliveryPipelineOperation
type
DeleteDeliveryPipelineOperation
struct
{
// contains filtered or unexported fields
}
DeleteDeliveryPipelineOperation manages a long-running operation from DeleteDeliveryPipeline.
func (*DeleteDeliveryPipelineOperation) Done
func
(
op
*
DeleteDeliveryPipelineOperation
)
Done
()
bool
Done 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
()
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 (*DeleteDeliveryPipelineOperation) Poll
func
(
op
*
DeleteDeliveryPipelineOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteDeliveryPipelineOperation) Wait
func
(
op
*
DeleteDeliveryPipelineOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
DeleteDeployPolicyOperation
type
DeleteDeployPolicyOperation
struct
{
// contains filtered or unexported fields
}
DeleteDeployPolicyOperation manages a long-running operation from DeleteDeployPolicy.
func (*DeleteDeployPolicyOperation) Done
func
(
op
*
DeleteDeployPolicyOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*DeleteDeployPolicyOperation) Metadata
func
(
op
*
DeleteDeployPolicyOperation
)
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 (*DeleteDeployPolicyOperation) Name
func
(
op
*
DeleteDeployPolicyOperation
)
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 (*DeleteDeployPolicyOperation) Poll
func
(
op
*
DeleteDeployPolicyOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteDeployPolicyOperation) Wait
func
(
op
*
DeleteDeployPolicyOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
DeleteTargetOperation
type
DeleteTargetOperation
struct
{
// contains filtered or unexported fields
}
DeleteTargetOperation manages a long-running operation from DeleteTarget.
func (*DeleteTargetOperation) Done
func
(
op
*
DeleteTargetOperation
)
Done
()
bool
Done 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
()
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 (*DeleteTargetOperation) Poll
func
(
op
*
DeleteTargetOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteTargetOperation) Wait
func
(
op
*
DeleteTargetOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
DeliveryPipelineIterator
type
DeliveryPipelineIterator
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
[]
*
deploypb
.
DeliveryPipeline
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
DeliveryPipelineIterator manages a stream of *deploypb.DeliveryPipeline.
func (*DeliveryPipelineIterator) All
func
(
it
*
DeliveryPipelineIterator
)
All
()
iter
.
Seq2
[
*
deploypb
.
DeliveryPipeline
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
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 more results. Once Next returns Done, all subsequent calls will return Done.
func (*DeliveryPipelineIterator) PageInfo
func
(
it
*
DeliveryPipelineIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
DeployPolicyIterator
type
DeployPolicyIterator
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
[]
*
deploypb
.
DeployPolicy
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
DeployPolicyIterator manages a stream of *deploypb.DeployPolicy.
func (*DeployPolicyIterator) All
func
(
it
*
DeployPolicyIterator
)
All
()
iter
.
Seq2
[
*
deploypb
.
DeployPolicy
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*DeployPolicyIterator) Next
func
(
it
*
DeployPolicyIterator
)
Next
()
(
*
deploypb
.
DeployPolicy
,
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 (*DeployPolicyIterator) PageInfo
func
(
it
*
DeployPolicyIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
JobRunIterator
type
JobRunIterator
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
[]
*
deploypb
.
JobRun
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
JobRunIterator manages a stream of *deploypb.JobRun.
func (*JobRunIterator) All
func
(
it
*
JobRunIterator
)
All
()
iter
.
Seq2
[
*
deploypb
.
JobRun
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
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 more results. Once Next returns Done, all subsequent calls will return Done.
func (*JobRunIterator) PageInfo
func
(
it
*
JobRunIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
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
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.
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
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.
ReleaseIterator
type
ReleaseIterator
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
[]
*
deploypb
.
Release
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
ReleaseIterator manages a stream of *deploypb.Release.
func (*ReleaseIterator) All
func
(
it
*
ReleaseIterator
)
All
()
iter
.
Seq2
[
*
deploypb
.
Release
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
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 more results. Once Next returns Done, all subsequent calls will return Done.
func (*ReleaseIterator) PageInfo
func
(
it
*
ReleaseIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
RolloutIterator
type
RolloutIterator
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
[]
*
deploypb
.
Rollout
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
RolloutIterator manages a stream of *deploypb.Rollout.
func (*RolloutIterator) All
func
(
it
*
RolloutIterator
)
All
()
iter
.
Seq2
[
*
deploypb
.
Rollout
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
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 more results. Once Next returns Done, all subsequent calls will return Done.
func (*RolloutIterator) PageInfo
func
(
it
*
RolloutIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
TargetIterator
type
TargetIterator
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
[]
*
deploypb
.
Target
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
TargetIterator manages a stream of *deploypb.Target.
func (*TargetIterator) All
func
(
it
*
TargetIterator
)
All
()
iter
.
Seq2
[
*
deploypb
.
Target
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
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 more results. Once Next returns Done, all subsequent calls will return Done.
func (*TargetIterator) PageInfo
func
(
it
*
TargetIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
UpdateAutomationOperation
type
UpdateAutomationOperation
struct
{
// contains filtered or unexported fields
}
UpdateAutomationOperation manages a long-running operation from UpdateAutomation.
func (*UpdateAutomationOperation) Done
func
(
op
*
UpdateAutomationOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*UpdateAutomationOperation) Metadata
func
(
op
*
UpdateAutomationOperation
)
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 (*UpdateAutomationOperation) Name
func
(
op
*
UpdateAutomationOperation
)
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 (*UpdateAutomationOperation) Poll
func
(
op
*
UpdateAutomationOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
deploypb
.
Automation
,
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 (*UpdateAutomationOperation) Wait
func
(
op
*
UpdateAutomationOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
deploypb
.
Automation
,
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.
UpdateCustomTargetTypeOperation
type
UpdateCustomTargetTypeOperation
struct
{
// contains filtered or unexported fields
}
UpdateCustomTargetTypeOperation manages a long-running operation from UpdateCustomTargetType.
func (*UpdateCustomTargetTypeOperation) Done
func
(
op
*
UpdateCustomTargetTypeOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*UpdateCustomTargetTypeOperation) Metadata
func
(
op
*
UpdateCustomTargetTypeOperation
)
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 (*UpdateCustomTargetTypeOperation) Name
func
(
op
*
UpdateCustomTargetTypeOperation
)
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 (*UpdateCustomTargetTypeOperation) Poll
func
(
op
*
UpdateCustomTargetTypeOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
deploypb
.
CustomTargetType
,
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 (*UpdateCustomTargetTypeOperation) Wait
func
(
op
*
UpdateCustomTargetTypeOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
deploypb
.
CustomTargetType
,
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.
UpdateDeliveryPipelineOperation
type
UpdateDeliveryPipelineOperation
struct
{
// contains filtered or unexported fields
}
UpdateDeliveryPipelineOperation manages a long-running operation from UpdateDeliveryPipeline.
func (*UpdateDeliveryPipelineOperation) Done
func
(
op
*
UpdateDeliveryPipelineOperation
)
Done
()
bool
Done 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
()
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 (*UpdateDeliveryPipelineOperation) Poll
func
(
op
*
UpdateDeliveryPipelineOperation
)
Poll
(
ctx
context
.
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 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 (*UpdateDeliveryPipelineOperation) Wait
func
(
op
*
UpdateDeliveryPipelineOperation
)
Wait
(
ctx
context
.
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.
UpdateDeployPolicyOperation
type
UpdateDeployPolicyOperation
struct
{
// contains filtered or unexported fields
}
UpdateDeployPolicyOperation manages a long-running operation from UpdateDeployPolicy.
func (*UpdateDeployPolicyOperation) Done
func
(
op
*
UpdateDeployPolicyOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*UpdateDeployPolicyOperation) Metadata
func
(
op
*
UpdateDeployPolicyOperation
)
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 (*UpdateDeployPolicyOperation) Name
func
(
op
*
UpdateDeployPolicyOperation
)
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 (*UpdateDeployPolicyOperation) Poll
func
(
op
*
UpdateDeployPolicyOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
deploypb
.
DeployPolicy
,
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 (*UpdateDeployPolicyOperation) Wait
func
(
op
*
UpdateDeployPolicyOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
deploypb
.
DeployPolicy
,
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
type
UpdateTargetOperation
struct
{
// contains filtered or unexported fields
}
UpdateTargetOperation manages a long-running operation from UpdateTarget.
func (*UpdateTargetOperation) Done
func
(
op
*
UpdateTargetOperation
)
Done
()
bool
Done 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
()
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 (*UpdateTargetOperation) Poll
func
(
op
*
UpdateTargetOperation
)
Poll
(
ctx
context
.
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 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 (*UpdateTargetOperation) Wait
func
(
op
*
UpdateTargetOperation
)
Wait
(
ctx
context
.
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.
