Package dataproc is an auto-generated package for the Cloud Dataproc API.
Manages Hadoop-based clusters and jobs on Google Cloud Platform.
General documentation
For information about setting deadlines, reusing contexts, and more please visit https://pkg.go.dev/cloud.google.com/go .
Example usage
To get started with this package, create a client.
ctx := context . Background () // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c , err := dataproc . NewAutoscalingPolicyClient ( 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.
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 := dataproc . NewAutoscalingPolicyClient ( ctx ) if err != nil { // TODO: Handle error. } defer c . Close () req := & dataprocpb . CreateAutoscalingPolicyRequest { // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#CreateAutoscalingPolicyRequest. } resp , err := c . CreateAutoscalingPolicy ( ctx , req ) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp
Use of Context
The ctx passed to NewAutoscalingPolicyClient 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.
AutoscalingPolicyCallOptions
type
AutoscalingPolicyCallOptions
struct
{
CreateAutoscalingPolicy
[]
gax
.
CallOption
UpdateAutoscalingPolicy
[]
gax
.
CallOption
GetAutoscalingPolicy
[]
gax
.
CallOption
ListAutoscalingPolicies
[]
gax
.
CallOption
DeleteAutoscalingPolicy
[]
gax
.
CallOption
}
AutoscalingPolicyCallOptions contains the retry settings for each method of AutoscalingPolicyClient.
AutoscalingPolicyClient
type
AutoscalingPolicyClient
struct
{
// The call options for this service.
CallOptions
*
AutoscalingPolicyCallOptions
// contains filtered or unexported fields
}
AutoscalingPolicyClient is a client for interacting with Cloud Dataproc API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
The API interface for managing autoscaling policies in the Dataproc API.
func NewAutoscalingPolicyClient
func
NewAutoscalingPolicyClient
(
ctx
context
.
Context
,
opts
...
option
.
ClientOption
)
(
*
AutoscalingPolicyClient
,
error
)
NewAutoscalingPolicyClient creates a new autoscaling policy service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
The API interface for managing autoscaling policies in the Dataproc API.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/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
:=
dataproc
.
NewAutoscalingPolicyClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func NewAutoscalingPolicyRESTClient
func
NewAutoscalingPolicyRESTClient
(
ctx
context
.
Context
,
opts
...
option
.
ClientOption
)
(
*
AutoscalingPolicyClient
,
error
)
NewAutoscalingPolicyRESTClient creates a new autoscaling policy service rest client.
The API interface for managing autoscaling policies in the Dataproc API.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/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
:=
dataproc
.
NewAutoscalingPolicyRESTClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func (*AutoscalingPolicyClient) Close
func
(
c
*
AutoscalingPolicyClient
)
Close
()
error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*AutoscalingPolicyClient) Connection (deprecated)
func
(
c
*
AutoscalingPolicyClient
)
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 (*AutoscalingPolicyClient) CreateAutoscalingPolicy
func
(
c
*
AutoscalingPolicyClient
)
CreateAutoscalingPolicy
(
ctx
context
.
Context
,
req
*
dataprocpb
.
CreateAutoscalingPolicyRequest
,
opts
...
gax
.
CallOption
)
(
*
dataprocpb
.
AutoscalingPolicy
,
error
)
CreateAutoscalingPolicy creates new autoscaling policy.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
)
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
:=
dataproc
.
NewAutoscalingPolicyClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
CreateAutoscalingPolicyRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#CreateAutoscalingPolicyRequest.
}
resp
,
err
:=
c
.
CreateAutoscalingPolicy
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*AutoscalingPolicyClient) DeleteAutoscalingPolicy
func
(
c
*
AutoscalingPolicyClient
)
DeleteAutoscalingPolicy
(
ctx
context
.
Context
,
req
*
dataprocpb
.
DeleteAutoscalingPolicyRequest
,
opts
...
gax
.
CallOption
)
error
DeleteAutoscalingPolicy deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
)
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
:=
dataproc
.
NewAutoscalingPolicyClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
DeleteAutoscalingPolicyRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#DeleteAutoscalingPolicyRequest.
}
err
=
c
.
DeleteAutoscalingPolicy
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*AutoscalingPolicyClient) GetAutoscalingPolicy
func
(
c
*
AutoscalingPolicyClient
)
GetAutoscalingPolicy
(
ctx
context
.
Context
,
req
*
dataprocpb
.
GetAutoscalingPolicyRequest
,
opts
...
gax
.
CallOption
)
(
*
dataprocpb
.
AutoscalingPolicy
,
error
)
GetAutoscalingPolicy retrieves autoscaling policy.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
)
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
:=
dataproc
.
NewAutoscalingPolicyClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
GetAutoscalingPolicyRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#GetAutoscalingPolicyRequest.
}
resp
,
err
:=
c
.
GetAutoscalingPolicy
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*AutoscalingPolicyClient) ListAutoscalingPolicies
func
(
c
*
AutoscalingPolicyClient
)
ListAutoscalingPolicies
(
ctx
context
.
Context
,
req
*
dataprocpb
.
ListAutoscalingPoliciesRequest
,
opts
...
gax
.
CallOption
)
*
AutoscalingPolicyIterator
ListAutoscalingPolicies lists autoscaling policies in the project.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
"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
:=
dataproc
.
NewAutoscalingPolicyClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
ListAutoscalingPoliciesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#ListAutoscalingPoliciesRequest.
}
it
:=
c
.
ListAutoscalingPolicies
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*AutoscalingPolicyClient) UpdateAutoscalingPolicy
func
(
c
*
AutoscalingPolicyClient
)
UpdateAutoscalingPolicy
(
ctx
context
.
Context
,
req
*
dataprocpb
.
UpdateAutoscalingPolicyRequest
,
opts
...
gax
.
CallOption
)
(
*
dataprocpb
.
AutoscalingPolicy
,
error
)
UpdateAutoscalingPolicy updates (replaces) autoscaling policy.
Disabled check for update_mask, because all updates will be full replacements.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
)
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
:=
dataproc
.
NewAutoscalingPolicyClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
UpdateAutoscalingPolicyRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#UpdateAutoscalingPolicyRequest.
}
resp
,
err
:=
c
.
UpdateAutoscalingPolicy
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
AutoscalingPolicyIterator
type
AutoscalingPolicyIterator
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
[]
*
dataprocpb
.
AutoscalingPolicy
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
AutoscalingPolicyIterator manages a stream of *dataprocpb.AutoscalingPolicy.
func (*AutoscalingPolicyIterator) Next
func
(
it
*
AutoscalingPolicyIterator
)
Next
()
(
*
dataprocpb
.
AutoscalingPolicy
,
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 (*AutoscalingPolicyIterator) PageInfo
func
(
it
*
AutoscalingPolicyIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
BatchControllerCallOptions
type
BatchControllerCallOptions
struct
{
CreateBatch
[]
gax
.
CallOption
GetBatch
[]
gax
.
CallOption
ListBatches
[]
gax
.
CallOption
DeleteBatch
[]
gax
.
CallOption
}
BatchControllerCallOptions contains the retry settings for each method of BatchControllerClient.
BatchControllerClient
type
BatchControllerClient
struct
{
// The call options for this service.
CallOptions
*
BatchControllerCallOptions
// 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
}
BatchControllerClient is a client for interacting with Cloud Dataproc API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
The BatchController provides methods to manage batch workloads.
func NewBatchControllerClient
func
NewBatchControllerClient
(
ctx
context
.
Context
,
opts
...
option
.
ClientOption
)
(
*
BatchControllerClient
,
error
)
NewBatchControllerClient creates a new batch controller client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
The BatchController provides methods to manage batch workloads.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/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
:=
dataproc
.
NewBatchControllerClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func NewBatchControllerRESTClient
func
NewBatchControllerRESTClient
(
ctx
context
.
Context
,
opts
...
option
.
ClientOption
)
(
*
BatchControllerClient
,
error
)
NewBatchControllerRESTClient creates a new batch controller rest client.
The BatchController provides methods to manage batch workloads.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/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
:=
dataproc
.
NewBatchControllerRESTClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func (*BatchControllerClient) Close
func
(
c
*
BatchControllerClient
)
Close
()
error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*BatchControllerClient) Connection (deprecated)
func
(
c
*
BatchControllerClient
)
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 (*BatchControllerClient) CreateBatch
func
(
c
*
BatchControllerClient
)
CreateBatch
(
ctx
context
.
Context
,
req
*
dataprocpb
.
CreateBatchRequest
,
opts
...
gax
.
CallOption
)
(
*
CreateBatchOperation
,
error
)
CreateBatch creates a batch workload that executes asynchronously.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
)
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
:=
dataproc
.
NewBatchControllerClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
CreateBatchRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#CreateBatchRequest.
}
op
,
err
:=
c
.
CreateBatch
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*BatchControllerClient) CreateBatchOperation
func
(
c
*
BatchControllerClient
)
CreateBatchOperation
(
name
string
)
*
CreateBatchOperation
CreateBatchOperation returns a new CreateBatchOperation from a given name. The name must be that of a previously created CreateBatchOperation, possibly from a different process.
func (*BatchControllerClient) DeleteBatch
func
(
c
*
BatchControllerClient
)
DeleteBatch
(
ctx
context
.
Context
,
req
*
dataprocpb
.
DeleteBatchRequest
,
opts
...
gax
.
CallOption
)
error
DeleteBatch deletes the batch workload resource. If the batch is not in terminal state, the delete fails and the response returns FAILED_PRECONDITION.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
)
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
:=
dataproc
.
NewBatchControllerClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
DeleteBatchRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#DeleteBatchRequest.
}
err
=
c
.
DeleteBatch
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*BatchControllerClient) GetBatch
func
(
c
*
BatchControllerClient
)
GetBatch
(
ctx
context
.
Context
,
req
*
dataprocpb
.
GetBatchRequest
,
opts
...
gax
.
CallOption
)
(
*
dataprocpb
.
Batch
,
error
)
GetBatch gets the batch workload resource representation.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
)
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
:=
dataproc
.
NewBatchControllerClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
GetBatchRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#GetBatchRequest.
}
resp
,
err
:=
c
.
GetBatch
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*BatchControllerClient) ListBatches
func
(
c
*
BatchControllerClient
)
ListBatches
(
ctx
context
.
Context
,
req
*
dataprocpb
.
ListBatchesRequest
,
opts
...
gax
.
CallOption
)
*
BatchIterator
ListBatches lists batch workloads.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
"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
:=
dataproc
.
NewBatchControllerClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
ListBatchesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#ListBatchesRequest.
}
it
:=
c
.
ListBatches
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
BatchIterator
type
BatchIterator
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
[]
*
dataprocpb
.
Batch
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
BatchIterator manages a stream of *dataprocpb.Batch.
func (*BatchIterator) Next
func
(
it
*
BatchIterator
)
Next
()
(
*
dataprocpb
.
Batch
,
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 (*BatchIterator) PageInfo
func
(
it
*
BatchIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
ClusterControllerCallOptions
type
ClusterControllerCallOptions
struct
{
CreateCluster
[]
gax
.
CallOption
UpdateCluster
[]
gax
.
CallOption
StopCluster
[]
gax
.
CallOption
StartCluster
[]
gax
.
CallOption
DeleteCluster
[]
gax
.
CallOption
GetCluster
[]
gax
.
CallOption
ListClusters
[]
gax
.
CallOption
DiagnoseCluster
[]
gax
.
CallOption
}
ClusterControllerCallOptions contains the retry settings for each method of ClusterControllerClient.
ClusterControllerClient
type
ClusterControllerClient
struct
{
// The call options for this service.
CallOptions
*
ClusterControllerCallOptions
// 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
}
ClusterControllerClient is a client for interacting with Cloud Dataproc API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
The ClusterControllerService provides methods to manage clusters of Compute Engine instances.
func NewClusterControllerClient
func
NewClusterControllerClient
(
ctx
context
.
Context
,
opts
...
option
.
ClientOption
)
(
*
ClusterControllerClient
,
error
)
NewClusterControllerClient creates a new cluster controller client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
The ClusterControllerService provides methods to manage clusters of Compute Engine instances.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/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
:=
dataproc
.
NewClusterControllerClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func NewClusterControllerRESTClient
func
NewClusterControllerRESTClient
(
ctx
context
.
Context
,
opts
...
option
.
ClientOption
)
(
*
ClusterControllerClient
,
error
)
NewClusterControllerRESTClient creates a new cluster controller rest client.
The ClusterControllerService provides methods to manage clusters of Compute Engine instances.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/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
:=
dataproc
.
NewClusterControllerRESTClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func (*ClusterControllerClient) Close
func
(
c
*
ClusterControllerClient
)
Close
()
error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*ClusterControllerClient) Connection (deprecated)
func
(
c
*
ClusterControllerClient
)
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 (*ClusterControllerClient) CreateCluster
func
(
c
*
ClusterControllerClient
)
CreateCluster
(
ctx
context
.
Context
,
req
*
dataprocpb
.
CreateClusterRequest
,
opts
...
gax
.
CallOption
)
(
*
CreateClusterOperation
,
error
)
CreateCluster creates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (at https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata ).
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
)
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
:=
dataproc
.
NewClusterControllerClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
CreateClusterRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#CreateClusterRequest.
}
op
,
err
:=
c
.
CreateCluster
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*ClusterControllerClient) CreateClusterOperation
func
(
c
*
ClusterControllerClient
)
CreateClusterOperation
(
name
string
)
*
CreateClusterOperation
CreateClusterOperation returns a new CreateClusterOperation from a given name. The name must be that of a previously created CreateClusterOperation, possibly from a different process.
func (*ClusterControllerClient) DeleteCluster
func
(
c
*
ClusterControllerClient
)
DeleteCluster
(
ctx
context
.
Context
,
req
*
dataprocpb
.
DeleteClusterRequest
,
opts
...
gax
.
CallOption
)
(
*
DeleteClusterOperation
,
error
)
DeleteCluster deletes a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (at https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata ).
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
)
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
:=
dataproc
.
NewClusterControllerClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
DeleteClusterRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#DeleteClusterRequest.
}
op
,
err
:=
c
.
DeleteCluster
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
err
=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*ClusterControllerClient) DeleteClusterOperation
func
(
c
*
ClusterControllerClient
)
DeleteClusterOperation
(
name
string
)
*
DeleteClusterOperation
DeleteClusterOperation returns a new DeleteClusterOperation from a given name. The name must be that of a previously created DeleteClusterOperation, possibly from a different process.
func (*ClusterControllerClient) DiagnoseCluster
func
(
c
*
ClusterControllerClient
)
DiagnoseCluster
(
ctx
context
.
Context
,
req
*
dataprocpb
.
DiagnoseClusterRequest
,
opts
...
gax
.
CallOption
)
(
*
DiagnoseClusterOperation
,
error
)
DiagnoseCluster gets cluster diagnostic information. The returned Operation.metadata will be ClusterOperationMetadata (at https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata ). After the operation completes, Operation.response contains DiagnoseClusterResults (at https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#diagnoseclusterresults ).
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
)
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
:=
dataproc
.
NewClusterControllerClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
DiagnoseClusterRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#DiagnoseClusterRequest.
}
op
,
err
:=
c
.
DiagnoseCluster
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*ClusterControllerClient) DiagnoseClusterOperation
func
(
c
*
ClusterControllerClient
)
DiagnoseClusterOperation
(
name
string
)
*
DiagnoseClusterOperation
DiagnoseClusterOperation returns a new DiagnoseClusterOperation from a given name. The name must be that of a previously created DiagnoseClusterOperation, possibly from a different process.
func (*ClusterControllerClient) GetCluster
func
(
c
*
ClusterControllerClient
)
GetCluster
(
ctx
context
.
Context
,
req
*
dataprocpb
.
GetClusterRequest
,
opts
...
gax
.
CallOption
)
(
*
dataprocpb
.
Cluster
,
error
)
GetCluster gets the resource representation for a cluster in a project.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
)
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
:=
dataproc
.
NewClusterControllerClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
GetClusterRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#GetClusterRequest.
}
resp
,
err
:=
c
.
GetCluster
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*ClusterControllerClient) ListClusters
func
(
c
*
ClusterControllerClient
)
ListClusters
(
ctx
context
.
Context
,
req
*
dataprocpb
.
ListClustersRequest
,
opts
...
gax
.
CallOption
)
*
ClusterIterator
ListClusters lists all regions/{region}/clusters in a project alphabetically.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
"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
:=
dataproc
.
NewClusterControllerClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
ListClustersRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#ListClustersRequest.
}
it
:=
c
.
ListClusters
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*ClusterControllerClient) StartCluster
func
(
c
*
ClusterControllerClient
)
StartCluster
(
ctx
context
.
Context
,
req
*
dataprocpb
.
StartClusterRequest
,
opts
...
gax
.
CallOption
)
(
*
StartClusterOperation
,
error
)
StartCluster starts a cluster in a project.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
)
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
:=
dataproc
.
NewClusterControllerClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
StartClusterRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#StartClusterRequest.
}
op
,
err
:=
c
.
StartCluster
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*ClusterControllerClient) StartClusterOperation
func
(
c
*
ClusterControllerClient
)
StartClusterOperation
(
name
string
)
*
StartClusterOperation
StartClusterOperation returns a new StartClusterOperation from a given name. The name must be that of a previously created StartClusterOperation, possibly from a different process.
func (*ClusterControllerClient) StopCluster
func
(
c
*
ClusterControllerClient
)
StopCluster
(
ctx
context
.
Context
,
req
*
dataprocpb
.
StopClusterRequest
,
opts
...
gax
.
CallOption
)
(
*
StopClusterOperation
,
error
)
StopCluster stops a cluster in a project.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
)
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
:=
dataproc
.
NewClusterControllerClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
StopClusterRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#StopClusterRequest.
}
op
,
err
:=
c
.
StopCluster
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*ClusterControllerClient) StopClusterOperation
func
(
c
*
ClusterControllerClient
)
StopClusterOperation
(
name
string
)
*
StopClusterOperation
StopClusterOperation returns a new StopClusterOperation from a given name. The name must be that of a previously created StopClusterOperation, possibly from a different process.
func (*ClusterControllerClient) UpdateCluster
func
(
c
*
ClusterControllerClient
)
UpdateCluster
(
ctx
context
.
Context
,
req
*
dataprocpb
.
UpdateClusterRequest
,
opts
...
gax
.
CallOption
)
(
*
UpdateClusterOperation
,
error
)
UpdateCluster updates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (at https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata ). The cluster must be in a [RUNNING][google.cloud.dataproc.v1.ClusterStatus.State] state or an error is returned.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
)
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
:=
dataproc
.
NewClusterControllerClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
UpdateClusterRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#UpdateClusterRequest.
}
op
,
err
:=
c
.
UpdateCluster
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*ClusterControllerClient) UpdateClusterOperation
func
(
c
*
ClusterControllerClient
)
UpdateClusterOperation
(
name
string
)
*
UpdateClusterOperation
UpdateClusterOperation returns a new UpdateClusterOperation from a given name. The name must be that of a previously created UpdateClusterOperation, possibly from a different process.
ClusterIterator
type
ClusterIterator
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
[]
*
dataprocpb
.
Cluster
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
ClusterIterator manages a stream of *dataprocpb.Cluster.
func (*ClusterIterator) Next
func
(
it
*
ClusterIterator
)
Next
()
(
*
dataprocpb
.
Cluster
,
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 (*ClusterIterator) PageInfo
func
(
it
*
ClusterIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
CreateBatchOperation
type
CreateBatchOperation
struct
{
// contains filtered or unexported fields
}
CreateBatchOperation manages a long-running operation from CreateBatch.
func (*CreateBatchOperation) Done
func
(
op
*
CreateBatchOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*CreateBatchOperation) Metadata
func
(
op
*
CreateBatchOperation
)
Metadata
()
(
*
dataprocpb
.
BatchOperationMetadata
,
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 (*CreateBatchOperation) Name
func
(
op
*
CreateBatchOperation
)
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 (*CreateBatchOperation) Poll
func
(
op
*
CreateBatchOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
dataprocpb
.
Batch
,
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 (*CreateBatchOperation) Wait
func
(
op
*
CreateBatchOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
dataprocpb
.
Batch
,
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.
CreateClusterOperation
type
CreateClusterOperation
struct
{
// contains filtered or unexported fields
}
CreateClusterOperation manages a long-running operation from CreateCluster.
func (*CreateClusterOperation) Delete
func
(
op
*
CreateClusterOperation
)
Delete
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Delete deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation.
func (*CreateClusterOperation) Done
func
(
op
*
CreateClusterOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*CreateClusterOperation) Metadata
func
(
op
*
CreateClusterOperation
)
Metadata
()
(
*
dataprocpb
.
ClusterOperationMetadata
,
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 (*CreateClusterOperation) Name
func
(
op
*
CreateClusterOperation
)
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 (*CreateClusterOperation) Poll
func
(
op
*
CreateClusterOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
dataprocpb
.
Cluster
,
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 (*CreateClusterOperation) Wait
func
(
op
*
CreateClusterOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
dataprocpb
.
Cluster
,
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.
CreateNodeGroupOperation
type
CreateNodeGroupOperation
struct
{
// contains filtered or unexported fields
}
CreateNodeGroupOperation manages a long-running operation from CreateNodeGroup.
func (*CreateNodeGroupOperation) Done
func
(
op
*
CreateNodeGroupOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*CreateNodeGroupOperation) Metadata
func
(
op
*
CreateNodeGroupOperation
)
Metadata
()
(
*
dataprocpb
.
NodeGroupOperationMetadata
,
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 (*CreateNodeGroupOperation) Name
func
(
op
*
CreateNodeGroupOperation
)
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 (*CreateNodeGroupOperation) Poll
func
(
op
*
CreateNodeGroupOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
dataprocpb
.
NodeGroup
,
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 (*CreateNodeGroupOperation) Wait
func
(
op
*
CreateNodeGroupOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
dataprocpb
.
NodeGroup
,
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.
DeleteClusterOperation
type
DeleteClusterOperation
struct
{
// contains filtered or unexported fields
}
DeleteClusterOperation manages a long-running operation from DeleteCluster.
func (*DeleteClusterOperation) Delete
func
(
op
*
DeleteClusterOperation
)
Delete
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Delete deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation.
func (*DeleteClusterOperation) Done
func
(
op
*
DeleteClusterOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*DeleteClusterOperation) Metadata
func
(
op
*
DeleteClusterOperation
)
Metadata
()
(
*
dataprocpb
.
ClusterOperationMetadata
,
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 (*DeleteClusterOperation) Name
func
(
op
*
DeleteClusterOperation
)
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 (*DeleteClusterOperation) Poll
func
(
op
*
DeleteClusterOperation
)
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 (*DeleteClusterOperation) Wait
func
(
op
*
DeleteClusterOperation
)
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.
DiagnoseClusterOperation
type
DiagnoseClusterOperation
struct
{
// contains filtered or unexported fields
}
DiagnoseClusterOperation manages a long-running operation from DiagnoseCluster.
func (*DiagnoseClusterOperation) Delete
func
(
op
*
DiagnoseClusterOperation
)
Delete
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Delete deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation.
func (*DiagnoseClusterOperation) Done
func
(
op
*
DiagnoseClusterOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*DiagnoseClusterOperation) Metadata
func
(
op
*
DiagnoseClusterOperation
)
Metadata
()
(
*
dataprocpb
.
ClusterOperationMetadata
,
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 (*DiagnoseClusterOperation) Name
func
(
op
*
DiagnoseClusterOperation
)
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 (*DiagnoseClusterOperation) Poll
func
(
op
*
DiagnoseClusterOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
dataprocpb
.
DiagnoseClusterResults
,
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 (*DiagnoseClusterOperation) Wait
func
(
op
*
DiagnoseClusterOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
dataprocpb
.
DiagnoseClusterResults
,
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.
InstantiateInlineWorkflowTemplateOperation
type
InstantiateInlineWorkflowTemplateOperation
struct
{
// contains filtered or unexported fields
}
InstantiateInlineWorkflowTemplateOperation manages a long-running operation from InstantiateInlineWorkflowTemplate.
func (*InstantiateInlineWorkflowTemplateOperation) Cancel
func
(
op
*
InstantiateInlineWorkflowTemplateOperation
)
Cancel
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Cancel starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients can use Poll or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, op.Poll returns an error with code Canceled.
func (*InstantiateInlineWorkflowTemplateOperation) Delete
func
(
op
*
InstantiateInlineWorkflowTemplateOperation
)
Delete
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Delete deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation.
func (*InstantiateInlineWorkflowTemplateOperation) Done
func
(
op
*
InstantiateInlineWorkflowTemplateOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*InstantiateInlineWorkflowTemplateOperation) Metadata
func
(
op
*
InstantiateInlineWorkflowTemplateOperation
)
Metadata
()
(
*
dataprocpb
.
WorkflowMetadata
,
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 (*InstantiateInlineWorkflowTemplateOperation) Name
func
(
op
*
InstantiateInlineWorkflowTemplateOperation
)
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 (*InstantiateInlineWorkflowTemplateOperation) Poll
func
(
op
*
InstantiateInlineWorkflowTemplateOperation
)
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 (*InstantiateInlineWorkflowTemplateOperation) Wait
func
(
op
*
InstantiateInlineWorkflowTemplateOperation
)
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.
InstantiateWorkflowTemplateOperation
type
InstantiateWorkflowTemplateOperation
struct
{
// contains filtered or unexported fields
}
InstantiateWorkflowTemplateOperation manages a long-running operation from InstantiateWorkflowTemplate.
func (*InstantiateWorkflowTemplateOperation) Cancel
func
(
op
*
InstantiateWorkflowTemplateOperation
)
Cancel
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Cancel starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients can use Poll or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, op.Poll returns an error with code Canceled.
func (*InstantiateWorkflowTemplateOperation) Delete
func
(
op
*
InstantiateWorkflowTemplateOperation
)
Delete
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Delete deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation.
func (*InstantiateWorkflowTemplateOperation) Done
func
(
op
*
InstantiateWorkflowTemplateOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*InstantiateWorkflowTemplateOperation) Metadata
func
(
op
*
InstantiateWorkflowTemplateOperation
)
Metadata
()
(
*
dataprocpb
.
WorkflowMetadata
,
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 (*InstantiateWorkflowTemplateOperation) Name
func
(
op
*
InstantiateWorkflowTemplateOperation
)
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 (*InstantiateWorkflowTemplateOperation) Poll
func
(
op
*
InstantiateWorkflowTemplateOperation
)
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 (*InstantiateWorkflowTemplateOperation) Wait
func
(
op
*
InstantiateWorkflowTemplateOperation
)
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.
JobControllerCallOptions
type
JobControllerCallOptions
struct
{
SubmitJob
[]
gax
.
CallOption
SubmitJobAsOperation
[]
gax
.
CallOption
GetJob
[]
gax
.
CallOption
ListJobs
[]
gax
.
CallOption
UpdateJob
[]
gax
.
CallOption
CancelJob
[]
gax
.
CallOption
DeleteJob
[]
gax
.
CallOption
}
JobControllerCallOptions contains the retry settings for each method of JobControllerClient.
JobControllerClient
type
JobControllerClient
struct
{
// The call options for this service.
CallOptions
*
JobControllerCallOptions
// 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
}
JobControllerClient is a client for interacting with Cloud Dataproc API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
The JobController provides methods to manage jobs.
func NewJobControllerClient
func
NewJobControllerClient
(
ctx
context
.
Context
,
opts
...
option
.
ClientOption
)
(
*
JobControllerClient
,
error
)
NewJobControllerClient creates a new job controller client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
The JobController provides methods to manage jobs.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/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
:=
dataproc
.
NewJobControllerClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func NewJobControllerRESTClient
func
NewJobControllerRESTClient
(
ctx
context
.
Context
,
opts
...
option
.
ClientOption
)
(
*
JobControllerClient
,
error
)
NewJobControllerRESTClient creates a new job controller rest client.
The JobController provides methods to manage jobs.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/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
:=
dataproc
.
NewJobControllerRESTClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func (*JobControllerClient) CancelJob
func
(
c
*
JobControllerClient
)
CancelJob
(
ctx
context
.
Context
,
req
*
dataprocpb
.
CancelJobRequest
,
opts
...
gax
.
CallOption
)
(
*
dataprocpb
.
Job
,
error
)
CancelJob starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list (at https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs/list ) or regions/{region}/jobs.get (at https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs/get ).
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
)
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
:=
dataproc
.
NewJobControllerClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
CancelJobRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#CancelJobRequest.
}
resp
,
err
:=
c
.
CancelJob
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*JobControllerClient) Close
func
(
c
*
JobControllerClient
)
Close
()
error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*JobControllerClient) Connection (deprecated)
func
(
c
*
JobControllerClient
)
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 (*JobControllerClient) DeleteJob
func
(
c
*
JobControllerClient
)
DeleteJob
(
ctx
context
.
Context
,
req
*
dataprocpb
.
DeleteJobRequest
,
opts
...
gax
.
CallOption
)
error
DeleteJob deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
)
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
:=
dataproc
.
NewJobControllerClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
DeleteJobRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#DeleteJobRequest.
}
err
=
c
.
DeleteJob
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*JobControllerClient) GetJob
func
(
c
*
JobControllerClient
)
GetJob
(
ctx
context
.
Context
,
req
*
dataprocpb
.
GetJobRequest
,
opts
...
gax
.
CallOption
)
(
*
dataprocpb
.
Job
,
error
)
GetJob gets the resource representation for a job in a project.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
)
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
:=
dataproc
.
NewJobControllerClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
GetJobRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#GetJobRequest.
}
resp
,
err
:=
c
.
GetJob
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*JobControllerClient) ListJobs
func
(
c
*
JobControllerClient
)
ListJobs
(
ctx
context
.
Context
,
req
*
dataprocpb
.
ListJobsRequest
,
opts
...
gax
.
CallOption
)
*
JobIterator
ListJobs lists regions/{region}/jobs in a project.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
"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
:=
dataproc
.
NewJobControllerClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
ListJobsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#ListJobsRequest.
}
it
:=
c
.
ListJobs
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*JobControllerClient) SubmitJob
func
(
c
*
JobControllerClient
)
SubmitJob
(
ctx
context
.
Context
,
req
*
dataprocpb
.
SubmitJobRequest
,
opts
...
gax
.
CallOption
)
(
*
dataprocpb
.
Job
,
error
)
SubmitJob submits a job to a cluster.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
)
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
:=
dataproc
.
NewJobControllerClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
SubmitJobRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#SubmitJobRequest.
}
resp
,
err
:=
c
.
SubmitJob
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*JobControllerClient) SubmitJobAsOperation
func
(
c
*
JobControllerClient
)
SubmitJobAsOperation
(
ctx
context
.
Context
,
req
*
dataprocpb
.
SubmitJobRequest
,
opts
...
gax
.
CallOption
)
(
*
SubmitJobAsOperationOperation
,
error
)
SubmitJobAsOperation submits job to a cluster.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
)
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
:=
dataproc
.
NewJobControllerClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
SubmitJobRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#SubmitJobRequest.
}
op
,
err
:=
c
.
SubmitJobAsOperation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*JobControllerClient) SubmitJobAsOperationOperation
func
(
c
*
JobControllerClient
)
SubmitJobAsOperationOperation
(
name
string
)
*
SubmitJobAsOperationOperation
SubmitJobAsOperationOperation returns a new SubmitJobAsOperationOperation from a given name. The name must be that of a previously created SubmitJobAsOperationOperation, possibly from a different process.
func (*JobControllerClient) UpdateJob
func
(
c
*
JobControllerClient
)
UpdateJob
(
ctx
context
.
Context
,
req
*
dataprocpb
.
UpdateJobRequest
,
opts
...
gax
.
CallOption
)
(
*
dataprocpb
.
Job
,
error
)
UpdateJob updates a job in a project.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
)
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
:=
dataproc
.
NewJobControllerClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
UpdateJobRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#UpdateJobRequest.
}
resp
,
err
:=
c
.
UpdateJob
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
JobIterator
type
JobIterator
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
[]
*
dataprocpb
.
Job
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
JobIterator manages a stream of *dataprocpb.Job.
func (*JobIterator) Next
func
(
it
*
JobIterator
)
Next
()
(
*
dataprocpb
.
Job
,
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 (*JobIterator) PageInfo
func
(
it
*
JobIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
NodeGroupControllerCallOptions
type
NodeGroupControllerCallOptions
struct
{
CreateNodeGroup
[]
gax
.
CallOption
ResizeNodeGroup
[]
gax
.
CallOption
GetNodeGroup
[]
gax
.
CallOption
}
NodeGroupControllerCallOptions contains the retry settings for each method of NodeGroupControllerClient.
NodeGroupControllerClient
type
NodeGroupControllerClient
struct
{
// The call options for this service.
CallOptions
*
NodeGroupControllerCallOptions
// 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
}
NodeGroupControllerClient is a client for interacting with Cloud Dataproc API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
The NodeGroupControllerService provides methods to manage node groups of Compute Engine managed instances.
func NewNodeGroupControllerClient
func
NewNodeGroupControllerClient
(
ctx
context
.
Context
,
opts
...
option
.
ClientOption
)
(
*
NodeGroupControllerClient
,
error
)
NewNodeGroupControllerClient creates a new node group controller client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
The NodeGroupControllerService provides methods to manage node groups of Compute Engine managed instances.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/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
:=
dataproc
.
NewNodeGroupControllerClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func NewNodeGroupControllerRESTClient
func
NewNodeGroupControllerRESTClient
(
ctx
context
.
Context
,
opts
...
option
.
ClientOption
)
(
*
NodeGroupControllerClient
,
error
)
NewNodeGroupControllerRESTClient creates a new node group controller rest client.
The NodeGroupControllerService provides methods to manage node groups of Compute Engine managed instances.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/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
:=
dataproc
.
NewNodeGroupControllerRESTClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func (*NodeGroupControllerClient) Close
func
(
c
*
NodeGroupControllerClient
)
Close
()
error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*NodeGroupControllerClient) Connection (deprecated)
func
(
c
*
NodeGroupControllerClient
)
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 (*NodeGroupControllerClient) CreateNodeGroup
func
(
c
*
NodeGroupControllerClient
)
CreateNodeGroup
(
ctx
context
.
Context
,
req
*
dataprocpb
.
CreateNodeGroupRequest
,
opts
...
gax
.
CallOption
)
(
*
CreateNodeGroupOperation
,
error
)
CreateNodeGroup creates a node group in a cluster. The returned Operation.metadata is NodeGroupOperationMetadata (at https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#nodegroupoperationmetadata ).
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
)
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
:=
dataproc
.
NewNodeGroupControllerClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
CreateNodeGroupRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#CreateNodeGroupRequest.
}
op
,
err
:=
c
.
CreateNodeGroup
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*NodeGroupControllerClient) CreateNodeGroupOperation
func
(
c
*
NodeGroupControllerClient
)
CreateNodeGroupOperation
(
name
string
)
*
CreateNodeGroupOperation
CreateNodeGroupOperation returns a new CreateNodeGroupOperation from a given name. The name must be that of a previously created CreateNodeGroupOperation, possibly from a different process.
func (*NodeGroupControllerClient) GetNodeGroup
func
(
c
*
NodeGroupControllerClient
)
GetNodeGroup
(
ctx
context
.
Context
,
req
*
dataprocpb
.
GetNodeGroupRequest
,
opts
...
gax
.
CallOption
)
(
*
dataprocpb
.
NodeGroup
,
error
)
GetNodeGroup gets the resource representation for a node group in a cluster.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
)
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
:=
dataproc
.
NewNodeGroupControllerClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
GetNodeGroupRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#GetNodeGroupRequest.
}
resp
,
err
:=
c
.
GetNodeGroup
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*NodeGroupControllerClient) ResizeNodeGroup
func
(
c
*
NodeGroupControllerClient
)
ResizeNodeGroup
(
ctx
context
.
Context
,
req
*
dataprocpb
.
ResizeNodeGroupRequest
,
opts
...
gax
.
CallOption
)
(
*
ResizeNodeGroupOperation
,
error
)
ResizeNodeGroup resizes a node group in a cluster. The returned Operation.metadata is NodeGroupOperationMetadata (at https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#nodegroupoperationmetadata ).
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
)
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
:=
dataproc
.
NewNodeGroupControllerClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
ResizeNodeGroupRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#ResizeNodeGroupRequest.
}
op
,
err
:=
c
.
ResizeNodeGroup
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*NodeGroupControllerClient) ResizeNodeGroupOperation
func
(
c
*
NodeGroupControllerClient
)
ResizeNodeGroupOperation
(
name
string
)
*
ResizeNodeGroupOperation
ResizeNodeGroupOperation returns a new ResizeNodeGroupOperation from a given name. The name must be that of a previously created ResizeNodeGroupOperation, possibly from a different process.
ResizeNodeGroupOperation
type
ResizeNodeGroupOperation
struct
{
// contains filtered or unexported fields
}
ResizeNodeGroupOperation manages a long-running operation from ResizeNodeGroup.
func (*ResizeNodeGroupOperation) Done
func
(
op
*
ResizeNodeGroupOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*ResizeNodeGroupOperation) Metadata
func
(
op
*
ResizeNodeGroupOperation
)
Metadata
()
(
*
dataprocpb
.
NodeGroupOperationMetadata
,
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 (*ResizeNodeGroupOperation) Name
func
(
op
*
ResizeNodeGroupOperation
)
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 (*ResizeNodeGroupOperation) Poll
func
(
op
*
ResizeNodeGroupOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
dataprocpb
.
NodeGroup
,
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 (*ResizeNodeGroupOperation) Wait
func
(
op
*
ResizeNodeGroupOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
dataprocpb
.
NodeGroup
,
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.
StartClusterOperation
type
StartClusterOperation
struct
{
// contains filtered or unexported fields
}
StartClusterOperation manages a long-running operation from StartCluster.
func (*StartClusterOperation) Done
func
(
op
*
StartClusterOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*StartClusterOperation) Metadata
func
(
op
*
StartClusterOperation
)
Metadata
()
(
*
dataprocpb
.
ClusterOperationMetadata
,
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 (*StartClusterOperation) Name
func
(
op
*
StartClusterOperation
)
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 (*StartClusterOperation) Poll
func
(
op
*
StartClusterOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
dataprocpb
.
Cluster
,
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 (*StartClusterOperation) Wait
func
(
op
*
StartClusterOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
dataprocpb
.
Cluster
,
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.
StopClusterOperation
type
StopClusterOperation
struct
{
// contains filtered or unexported fields
}
StopClusterOperation manages a long-running operation from StopCluster.
func (*StopClusterOperation) Done
func
(
op
*
StopClusterOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*StopClusterOperation) Metadata
func
(
op
*
StopClusterOperation
)
Metadata
()
(
*
dataprocpb
.
ClusterOperationMetadata
,
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 (*StopClusterOperation) Name
func
(
op
*
StopClusterOperation
)
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 (*StopClusterOperation) Poll
func
(
op
*
StopClusterOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
dataprocpb
.
Cluster
,
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 (*StopClusterOperation) Wait
func
(
op
*
StopClusterOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
dataprocpb
.
Cluster
,
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.
SubmitJobAsOperationOperation
type
SubmitJobAsOperationOperation
struct
{
// contains filtered or unexported fields
}
SubmitJobAsOperationOperation manages a long-running operation from SubmitJobAsOperation.
func (*SubmitJobAsOperationOperation) Done
func
(
op
*
SubmitJobAsOperationOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*SubmitJobAsOperationOperation) Metadata
func
(
op
*
SubmitJobAsOperationOperation
)
Metadata
()
(
*
dataprocpb
.
JobMetadata
,
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 (*SubmitJobAsOperationOperation) Name
func
(
op
*
SubmitJobAsOperationOperation
)
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 (*SubmitJobAsOperationOperation) Poll
func
(
op
*
SubmitJobAsOperationOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
dataprocpb
.
Job
,
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 (*SubmitJobAsOperationOperation) Wait
func
(
op
*
SubmitJobAsOperationOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
dataprocpb
.
Job
,
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.
UpdateClusterOperation
type
UpdateClusterOperation
struct
{
// contains filtered or unexported fields
}
UpdateClusterOperation manages a long-running operation from UpdateCluster.
func (*UpdateClusterOperation) Delete
func
(
op
*
UpdateClusterOperation
)
Delete
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Delete deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation.
func (*UpdateClusterOperation) Done
func
(
op
*
UpdateClusterOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*UpdateClusterOperation) Metadata
func
(
op
*
UpdateClusterOperation
)
Metadata
()
(
*
dataprocpb
.
ClusterOperationMetadata
,
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 (*UpdateClusterOperation) Name
func
(
op
*
UpdateClusterOperation
)
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 (*UpdateClusterOperation) Poll
func
(
op
*
UpdateClusterOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
dataprocpb
.
Cluster
,
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 (*UpdateClusterOperation) Wait
func
(
op
*
UpdateClusterOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
dataprocpb
.
Cluster
,
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.
WorkflowTemplateCallOptions
type
WorkflowTemplateCallOptions
struct
{
CreateWorkflowTemplate
[]
gax
.
CallOption
GetWorkflowTemplate
[]
gax
.
CallOption
InstantiateWorkflowTemplate
[]
gax
.
CallOption
InstantiateInlineWorkflowTemplate
[]
gax
.
CallOption
UpdateWorkflowTemplate
[]
gax
.
CallOption
ListWorkflowTemplates
[]
gax
.
CallOption
DeleteWorkflowTemplate
[]
gax
.
CallOption
}
WorkflowTemplateCallOptions contains the retry settings for each method of WorkflowTemplateClient.
WorkflowTemplateClient
type
WorkflowTemplateClient
struct
{
// The call options for this service.
CallOptions
*
WorkflowTemplateCallOptions
// 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
}
WorkflowTemplateClient is a client for interacting with Cloud Dataproc API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
The API interface for managing Workflow Templates in the Dataproc API.
func NewWorkflowTemplateClient
func
NewWorkflowTemplateClient
(
ctx
context
.
Context
,
opts
...
option
.
ClientOption
)
(
*
WorkflowTemplateClient
,
error
)
NewWorkflowTemplateClient creates a new workflow template service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
The API interface for managing Workflow Templates in the Dataproc API.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/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
:=
dataproc
.
NewWorkflowTemplateClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func NewWorkflowTemplateRESTClient
func
NewWorkflowTemplateRESTClient
(
ctx
context
.
Context
,
opts
...
option
.
ClientOption
)
(
*
WorkflowTemplateClient
,
error
)
NewWorkflowTemplateRESTClient creates a new workflow template service rest client.
The API interface for managing Workflow Templates in the Dataproc API.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/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
:=
dataproc
.
NewWorkflowTemplateRESTClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func (*WorkflowTemplateClient) Close
func
(
c
*
WorkflowTemplateClient
)
Close
()
error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*WorkflowTemplateClient) Connection (deprecated)
func
(
c
*
WorkflowTemplateClient
)
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 (*WorkflowTemplateClient) CreateWorkflowTemplate
func
(
c
*
WorkflowTemplateClient
)
CreateWorkflowTemplate
(
ctx
context
.
Context
,
req
*
dataprocpb
.
CreateWorkflowTemplateRequest
,
opts
...
gax
.
CallOption
)
(
*
dataprocpb
.
WorkflowTemplate
,
error
)
CreateWorkflowTemplate creates new workflow template.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
)
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
:=
dataproc
.
NewWorkflowTemplateClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
CreateWorkflowTemplateRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#CreateWorkflowTemplateRequest.
}
resp
,
err
:=
c
.
CreateWorkflowTemplate
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*WorkflowTemplateClient) DeleteWorkflowTemplate
func
(
c
*
WorkflowTemplateClient
)
DeleteWorkflowTemplate
(
ctx
context
.
Context
,
req
*
dataprocpb
.
DeleteWorkflowTemplateRequest
,
opts
...
gax
.
CallOption
)
error
DeleteWorkflowTemplate deletes a workflow template. It does not cancel in-progress workflows.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
)
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
:=
dataproc
.
NewWorkflowTemplateClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
DeleteWorkflowTemplateRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#DeleteWorkflowTemplateRequest.
}
err
=
c
.
DeleteWorkflowTemplate
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*WorkflowTemplateClient) GetWorkflowTemplate
func
(
c
*
WorkflowTemplateClient
)
GetWorkflowTemplate
(
ctx
context
.
Context
,
req
*
dataprocpb
.
GetWorkflowTemplateRequest
,
opts
...
gax
.
CallOption
)
(
*
dataprocpb
.
WorkflowTemplate
,
error
)
GetWorkflowTemplate retrieves the latest workflow template.
Can retrieve previously instantiated template by specifying optional version parameter.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
)
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
:=
dataproc
.
NewWorkflowTemplateClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
GetWorkflowTemplateRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#GetWorkflowTemplateRequest.
}
resp
,
err
:=
c
.
GetWorkflowTemplate
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*WorkflowTemplateClient) InstantiateInlineWorkflowTemplate
func
(
c
*
WorkflowTemplateClient
)
InstantiateInlineWorkflowTemplate
(
ctx
context
.
Context
,
req
*
dataprocpb
.
InstantiateInlineWorkflowTemplateRequest
,
opts
...
gax
.
CallOption
)
(
*
InstantiateInlineWorkflowTemplateOperation
,
error
)
InstantiateInlineWorkflowTemplate instantiates a template and begins execution.
This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.
The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.
The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.
The Operation.metadata will be WorkflowMetadata (at https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata ). Also see Using WorkflowMetadata (at https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata ).
On successful completion, Operation.response will be Empty.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
)
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
:=
dataproc
.
NewWorkflowTemplateClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
InstantiateInlineWorkflowTemplateRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#InstantiateInlineWorkflowTemplateRequest.
}
op
,
err
:=
c
.
InstantiateInlineWorkflowTemplate
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
err
=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*WorkflowTemplateClient) InstantiateInlineWorkflowTemplateOperation
func
(
c
*
WorkflowTemplateClient
)
InstantiateInlineWorkflowTemplateOperation
(
name
string
)
*
InstantiateInlineWorkflowTemplateOperation
InstantiateInlineWorkflowTemplateOperation returns a new InstantiateInlineWorkflowTemplateOperation from a given name. The name must be that of a previously created InstantiateInlineWorkflowTemplateOperation, possibly from a different process.
func (*WorkflowTemplateClient) InstantiateWorkflowTemplate
func
(
c
*
WorkflowTemplateClient
)
InstantiateWorkflowTemplate
(
ctx
context
.
Context
,
req
*
dataprocpb
.
InstantiateWorkflowTemplateRequest
,
opts
...
gax
.
CallOption
)
(
*
InstantiateWorkflowTemplateOperation
,
error
)
InstantiateWorkflowTemplate instantiates a template and begins execution.
The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.
The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.
The Operation.metadata will be WorkflowMetadata (at https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata ). Also see Using WorkflowMetadata (at https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata ).
On successful completion, Operation.response will be Empty.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
)
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
:=
dataproc
.
NewWorkflowTemplateClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
InstantiateWorkflowTemplateRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#InstantiateWorkflowTemplateRequest.
}
op
,
err
:=
c
.
InstantiateWorkflowTemplate
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
err
=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*WorkflowTemplateClient) InstantiateWorkflowTemplateOperation
func
(
c
*
WorkflowTemplateClient
)
InstantiateWorkflowTemplateOperation
(
name
string
)
*
InstantiateWorkflowTemplateOperation
InstantiateWorkflowTemplateOperation returns a new InstantiateWorkflowTemplateOperation from a given name. The name must be that of a previously created InstantiateWorkflowTemplateOperation, possibly from a different process.
func (*WorkflowTemplateClient) ListWorkflowTemplates
func
(
c
*
WorkflowTemplateClient
)
ListWorkflowTemplates
(
ctx
context
.
Context
,
req
*
dataprocpb
.
ListWorkflowTemplatesRequest
,
opts
...
gax
.
CallOption
)
*
WorkflowTemplateIterator
ListWorkflowTemplates lists workflows that match the specified filter in the request.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
"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
:=
dataproc
.
NewWorkflowTemplateClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
ListWorkflowTemplatesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#ListWorkflowTemplatesRequest.
}
it
:=
c
.
ListWorkflowTemplates
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*WorkflowTemplateClient) UpdateWorkflowTemplate
func
(
c
*
WorkflowTemplateClient
)
UpdateWorkflowTemplate
(
ctx
context
.
Context
,
req
*
dataprocpb
.
UpdateWorkflowTemplateRequest
,
opts
...
gax
.
CallOption
)
(
*
dataprocpb
.
WorkflowTemplate
,
error
)
UpdateWorkflowTemplate updates (replaces) workflow template. The updated template must contain version that matches the current server version.
Example
package
main
import
(
"context"
dataproc
"cloud.google.com/go/dataproc/apiv1"
dataprocpb
"cloud.google.com/go/dataproc/apiv1/dataprocpb"
)
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
:=
dataproc
.
NewWorkflowTemplateClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& dataprocpb
.
UpdateWorkflowTemplateRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/dataproc/apiv1/dataprocpb#UpdateWorkflowTemplateRequest.
}
resp
,
err
:=
c
.
UpdateWorkflowTemplate
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
WorkflowTemplateIterator
type
WorkflowTemplateIterator
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
[]
*
dataprocpb
.
WorkflowTemplate
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
WorkflowTemplateIterator manages a stream of *dataprocpb.WorkflowTemplate.
func (*WorkflowTemplateIterator) Next
func
(
it
*
WorkflowTemplateIterator
)
Next
()
(
*
dataprocpb
.
WorkflowTemplate
,
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 (*WorkflowTemplateIterator) PageInfo
func
(
it
*
WorkflowTemplateIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
