Package managedkafka is an auto-generated package for the Managed Service for Apache Kafka API.
Manage Apache Kafka clusters and resources.
NOTE : This package is in beta . It is not stable , and may be subject to changes .
General documentation
For information that is relevant for all client libraries please reference https://pkg.go.dev/cloud.google.com/go#pkg-overview . Some information on this page includes:
- Authentication and Authorization
- Timeouts and Cancellation
- Testing against Client Libraries
- Debugging Client Libraries
- Inspecting errors
Example usage
To get started with this package, create a client.
// go get cloud.google.com/go/managedkafka/apiv1@latest ctx := context . Background () // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c , err := managedkafka . NewClient ( ctx ) if err != nil { // TODO: Handle error. } defer c . Close ()
The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.
Using the Client
The following is an example of making an API call with the newly created client, mentioned above.
req := & managedkafkapb . CreateClusterRequest { // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#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
Use of Context
The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.
To close the open connection, use the Close() method.
Functions
func DefaultAuthScopes
func
DefaultAuthScopes
()
[]
string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
CallOptions
type
CallOptions
struct
{
ListClusters
[]
gax
.
CallOption
GetCluster
[]
gax
.
CallOption
CreateCluster
[]
gax
.
CallOption
UpdateCluster
[]
gax
.
CallOption
DeleteCluster
[]
gax
.
CallOption
ListTopics
[]
gax
.
CallOption
GetTopic
[]
gax
.
CallOption
CreateTopic
[]
gax
.
CallOption
UpdateTopic
[]
gax
.
CallOption
DeleteTopic
[]
gax
.
CallOption
ListConsumerGroups
[]
gax
.
CallOption
GetConsumerGroup
[]
gax
.
CallOption
UpdateConsumerGroup
[]
gax
.
CallOption
DeleteConsumerGroup
[]
gax
.
CallOption
GetLocation
[]
gax
.
CallOption
ListLocations
[]
gax
.
CallOption
CancelOperation
[]
gax
.
CallOption
DeleteOperation
[]
gax
.
CallOption
GetOperation
[]
gax
.
CallOption
ListOperations
[]
gax
.
CallOption
}
CallOptions contains the retry settings for each method of Client.
Client
type
Client
struct
{
// The call options for this service.
CallOptions
*
CallOptions
// LROClient is used internally to handle long-running operations.
// It is exposed so that its CallOptions can be modified if required.
// Users should not Close this client.
LROClient
*
lroauto
.
OperationsClient
// contains filtered or unexported fields
}
Client is a client for interacting with Managed Service for Apache Kafka API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
The service that a client application uses to manage Apache Kafka clusters, topics and consumer groups.
func NewClient
NewClient creates a new managed kafka client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
The service that a client application uses to manage Apache Kafka clusters, topics and consumer groups.
Example
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/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
:=
managedkafka
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func NewRESTClient
NewRESTClient creates a new managed kafka rest client.
The service that a client application uses to manage Apache Kafka clusters, topics and consumer groups.
Example
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/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
:=
managedkafka
.
NewRESTClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func (*Client) CancelOperation
func
(
c
*
Client
)
CancelOperation
(
ctx
context
.
Context
,
req
*
longrunningpb
.
CancelOperationRequest
,
opts
...
gax
.
CallOption
)
error
CancelOperation is a utility method from google.longrunning.Operations.
Example
package
main
import
(
"context"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
managedkafka
"cloud.google.com/go/managedkafka/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
:=
managedkafka
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& longrunningpb
.
CancelOperationRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#CancelOperationRequest.
}
err
=
c
.
CancelOperation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*Client) Close
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*Client) Connection (deprecated)
func
(
c
*
Client
)
Connection
()
*
grpc
.
ClientConn
Connection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*Client) CreateCluster
func
(
c
*
Client
)
CreateCluster
(
ctx
context
.
Context
,
req
*
managedkafkapb
.
CreateClusterRequest
,
opts
...
gax
.
CallOption
)
(
*
CreateClusterOperation
,
error
)
CreateCluster creates a new cluster in a given project and location.
Example
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
)
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
:=
managedkafka
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
CreateClusterRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#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 (*Client) CreateClusterOperation
func
(
c
*
Client
)
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 (*Client) CreateTopic
func
(
c
*
Client
)
CreateTopic
(
ctx
context
.
Context
,
req
*
managedkafkapb
.
CreateTopicRequest
,
opts
...
gax
.
CallOption
)
(
*
managedkafkapb
.
Topic
,
error
)
CreateTopic creates a new topic in a given project and location.
Example
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
)
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
:=
managedkafka
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
CreateTopicRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#CreateTopicRequest.
}
resp
,
err
:=
c
.
CreateTopic
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) DeleteCluster
func
(
c
*
Client
)
DeleteCluster
(
ctx
context
.
Context
,
req
*
managedkafkapb
.
DeleteClusterRequest
,
opts
...
gax
.
CallOption
)
(
*
DeleteClusterOperation
,
error
)
DeleteCluster deletes a single cluster.
Example
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
)
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
:=
managedkafka
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
DeleteClusterRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#DeleteClusterRequest.
}
op
,
err
:=
c
.
DeleteCluster
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
err
=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*Client) DeleteClusterOperation
func
(
c
*
Client
)
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 (*Client) DeleteConsumerGroup
func
(
c
*
Client
)
DeleteConsumerGroup
(
ctx
context
.
Context
,
req
*
managedkafkapb
.
DeleteConsumerGroupRequest
,
opts
...
gax
.
CallOption
)
error
DeleteConsumerGroup deletes a single consumer group.
Example
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
)
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
:=
managedkafka
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
DeleteConsumerGroupRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#DeleteConsumerGroupRequest.
}
err
=
c
.
DeleteConsumerGroup
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*Client) DeleteOperation
func
(
c
*
Client
)
DeleteOperation
(
ctx
context
.
Context
,
req
*
longrunningpb
.
DeleteOperationRequest
,
opts
...
gax
.
CallOption
)
error
DeleteOperation is a utility method from google.longrunning.Operations.
Example
package
main
import
(
"context"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
managedkafka
"cloud.google.com/go/managedkafka/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
:=
managedkafka
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& longrunningpb
.
DeleteOperationRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#DeleteOperationRequest.
}
err
=
c
.
DeleteOperation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*Client) DeleteTopic
func
(
c
*
Client
)
DeleteTopic
(
ctx
context
.
Context
,
req
*
managedkafkapb
.
DeleteTopicRequest
,
opts
...
gax
.
CallOption
)
error
DeleteTopic deletes a single topic.
Example
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
)
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
:=
managedkafka
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
DeleteTopicRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#DeleteTopicRequest.
}
err
=
c
.
DeleteTopic
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*Client) GetCluster
func
(
c
*
Client
)
GetCluster
(
ctx
context
.
Context
,
req
*
managedkafkapb
.
GetClusterRequest
,
opts
...
gax
.
CallOption
)
(
*
managedkafkapb
.
Cluster
,
error
)
GetCluster returns the properties of a single cluster.
Example
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
)
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
:=
managedkafka
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
GetClusterRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#GetClusterRequest.
}
resp
,
err
:=
c
.
GetCluster
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetConsumerGroup
func
(
c
*
Client
)
GetConsumerGroup
(
ctx
context
.
Context
,
req
*
managedkafkapb
.
GetConsumerGroupRequest
,
opts
...
gax
.
CallOption
)
(
*
managedkafkapb
.
ConsumerGroup
,
error
)
GetConsumerGroup returns the properties of a single consumer group.
Example
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
)
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
:=
managedkafka
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
GetConsumerGroupRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#GetConsumerGroupRequest.
}
resp
,
err
:=
c
.
GetConsumerGroup
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetLocation
func
(
c
*
Client
)
GetLocation
(
ctx
context
.
Context
,
req
*
locationpb
.
GetLocationRequest
,
opts
...
gax
.
CallOption
)
(
*
locationpb
.
Location
,
error
)
GetLocation gets information about a location.
Example
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
locationpb
"google.golang.org/genproto/googleapis/cloud/location"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
managedkafka
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& locationpb
.
GetLocationRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#GetLocationRequest.
}
resp
,
err
:=
c
.
GetLocation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetOperation
func
(
c
*
Client
)
GetOperation
(
ctx
context
.
Context
,
req
*
longrunningpb
.
GetOperationRequest
,
opts
...
gax
.
CallOption
)
(
*
longrunningpb
.
Operation
,
error
)
GetOperation is a utility method from google.longrunning.Operations.
Example
package
main
import
(
"context"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
managedkafka
"cloud.google.com/go/managedkafka/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
:=
managedkafka
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& longrunningpb
.
GetOperationRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest.
}
resp
,
err
:=
c
.
GetOperation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetTopic
func
(
c
*
Client
)
GetTopic
(
ctx
context
.
Context
,
req
*
managedkafkapb
.
GetTopicRequest
,
opts
...
gax
.
CallOption
)
(
*
managedkafkapb
.
Topic
,
error
)
GetTopic returns the properties of a single topic.
Example
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
)
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
:=
managedkafka
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
GetTopicRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#GetTopicRequest.
}
resp
,
err
:=
c
.
GetTopic
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) ListClusters
func
(
c
*
Client
)
ListClusters
(
ctx
context
.
Context
,
req
*
managedkafkapb
.
ListClustersRequest
,
opts
...
gax
.
CallOption
)
*
ClusterIterator
ListClusters lists the clusters in a given project and location.
Examples
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
"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
:=
managedkafka
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
ListClustersRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#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
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
managedkafkapb
.
ListClustersResponse
)
}
}
all
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
)
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
:=
managedkafka
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
ListClustersRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#ListClustersRequest.
}
for
resp
,
err
:=
range
c
.
ListClusters
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) ListConsumerGroups
func
(
c
*
Client
)
ListConsumerGroups
(
ctx
context
.
Context
,
req
*
managedkafkapb
.
ListConsumerGroupsRequest
,
opts
...
gax
.
CallOption
)
*
ConsumerGroupIterator
ListConsumerGroups lists the consumer groups in a given cluster.
Examples
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
"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
:=
managedkafka
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
ListConsumerGroupsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#ListConsumerGroupsRequest.
}
it
:=
c
.
ListConsumerGroups
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
managedkafkapb
.
ListConsumerGroupsResponse
)
}
}
all
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
)
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
:=
managedkafka
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
ListConsumerGroupsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#ListConsumerGroupsRequest.
}
for
resp
,
err
:=
range
c
.
ListConsumerGroups
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) ListLocations
func
(
c
*
Client
)
ListLocations
(
ctx
context
.
Context
,
req
*
locationpb
.
ListLocationsRequest
,
opts
...
gax
.
CallOption
)
*
LocationIterator
ListLocations lists information about the supported locations for this service.
Examples
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
"google.golang.org/api/iterator"
locationpb
"google.golang.org/genproto/googleapis/cloud/location"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
managedkafka
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& locationpb
.
ListLocationsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.
}
it
:=
c
.
ListLocations
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
locationpb
.
ListLocationsResponse
)
}
}
all
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
locationpb
"google.golang.org/genproto/googleapis/cloud/location"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
managedkafka
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& locationpb
.
ListLocationsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.
}
for
resp
,
err
:=
range
c
.
ListLocations
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) ListOperations
func
(
c
*
Client
)
ListOperations
(
ctx
context
.
Context
,
req
*
longrunningpb
.
ListOperationsRequest
,
opts
...
gax
.
CallOption
)
*
OperationIterator
ListOperations is a utility method from google.longrunning.Operations.
Examples
package
main
import
(
"context"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
"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
:=
managedkafka
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& longrunningpb
.
ListOperationsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
it
:=
c
.
ListOperations
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
longrunningpb
.
ListOperationsResponse
)
}
}
all
package
main
import
(
"context"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
managedkafka
"cloud.google.com/go/managedkafka/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
:=
managedkafka
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& longrunningpb
.
ListOperationsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
for
resp
,
err
:=
range
c
.
ListOperations
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) ListTopics
func
(
c
*
Client
)
ListTopics
(
ctx
context
.
Context
,
req
*
managedkafkapb
.
ListTopicsRequest
,
opts
...
gax
.
CallOption
)
*
TopicIterator
ListTopics lists the topics in a given cluster.
Examples
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
"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
:=
managedkafka
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
ListTopicsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#ListTopicsRequest.
}
it
:=
c
.
ListTopics
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
managedkafkapb
.
ListTopicsResponse
)
}
}
all
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
)
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
:=
managedkafka
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
ListTopicsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#ListTopicsRequest.
}
for
resp
,
err
:=
range
c
.
ListTopics
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) UpdateCluster
func
(
c
*
Client
)
UpdateCluster
(
ctx
context
.
Context
,
req
*
managedkafkapb
.
UpdateClusterRequest
,
opts
...
gax
.
CallOption
)
(
*
UpdateClusterOperation
,
error
)
UpdateCluster updates the properties of a single cluster.
Example
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
)
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
:=
managedkafka
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
UpdateClusterRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#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 (*Client) UpdateClusterOperation
func
(
c
*
Client
)
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.
func (*Client) UpdateConsumerGroup
func
(
c
*
Client
)
UpdateConsumerGroup
(
ctx
context
.
Context
,
req
*
managedkafkapb
.
UpdateConsumerGroupRequest
,
opts
...
gax
.
CallOption
)
(
*
managedkafkapb
.
ConsumerGroup
,
error
)
UpdateConsumerGroup updates the properties of a single consumer group.
Example
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
)
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
:=
managedkafka
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
UpdateConsumerGroupRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#UpdateConsumerGroupRequest.
}
resp
,
err
:=
c
.
UpdateConsumerGroup
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) UpdateTopic
func
(
c
*
Client
)
UpdateTopic
(
ctx
context
.
Context
,
req
*
managedkafkapb
.
UpdateTopicRequest
,
opts
...
gax
.
CallOption
)
(
*
managedkafkapb
.
Topic
,
error
)
UpdateTopic updates the properties of a single topic.
Example
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
)
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
:=
managedkafka
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
UpdateTopicRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#UpdateTopicRequest.
}
resp
,
err
:=
c
.
UpdateTopic
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
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
[]
*
managedkafkapb
.
Cluster
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
ClusterIterator manages a stream of *managedkafkapb.Cluster.
func (*ClusterIterator) All
func
(
it
*
ClusterIterator
)
All
()
iter
.
Seq2
[
*
managedkafkapb
.
Cluster
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*ClusterIterator) Next
func
(
it
*
ClusterIterator
)
Next
()
(
*
managedkafkapb
.
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.
ConnectClusterIterator
type
ConnectClusterIterator
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
[]
*
managedkafkapb
.
ConnectCluster
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
ConnectClusterIterator manages a stream of *managedkafkapb.ConnectCluster.
func (*ConnectClusterIterator) All
func
(
it
*
ConnectClusterIterator
)
All
()
iter
.
Seq2
[
*
managedkafkapb
.
ConnectCluster
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*ConnectClusterIterator) Next
func
(
it
*
ConnectClusterIterator
)
Next
()
(
*
managedkafkapb
.
ConnectCluster
,
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 (*ConnectClusterIterator) PageInfo
func
(
it
*
ConnectClusterIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
ConnectorIterator
type
ConnectorIterator
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
[]
*
managedkafkapb
.
Connector
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
ConnectorIterator manages a stream of *managedkafkapb.Connector.
func (*ConnectorIterator) All
func
(
it
*
ConnectorIterator
)
All
()
iter
.
Seq2
[
*
managedkafkapb
.
Connector
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*ConnectorIterator) Next
func
(
it
*
ConnectorIterator
)
Next
()
(
*
managedkafkapb
.
Connector
,
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 (*ConnectorIterator) PageInfo
func
(
it
*
ConnectorIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
ConsumerGroupIterator
type
ConsumerGroupIterator
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
[]
*
managedkafkapb
.
ConsumerGroup
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
ConsumerGroupIterator manages a stream of *managedkafkapb.ConsumerGroup.
func (*ConsumerGroupIterator) All
func
(
it
*
ConsumerGroupIterator
)
All
()
iter
.
Seq2
[
*
managedkafkapb
.
ConsumerGroup
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*ConsumerGroupIterator) Next
func
(
it
*
ConsumerGroupIterator
)
Next
()
(
*
managedkafkapb
.
ConsumerGroup
,
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 (*ConsumerGroupIterator) PageInfo
func
(
it
*
ConsumerGroupIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
CreateClusterOperation
type
CreateClusterOperation
struct
{
// contains filtered or unexported fields
}
CreateClusterOperation manages a long-running operation from CreateCluster.
func (*CreateClusterOperation) Done
func
(
op
*
CreateClusterOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*CreateClusterOperation) Metadata
func
(
op
*
CreateClusterOperation
)
Metadata
()
(
*
managedkafkapb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*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
)
(
*
managedkafkapb
.
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
)
(
*
managedkafkapb
.
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.
CreateConnectClusterOperation
type
CreateConnectClusterOperation
struct
{
// contains filtered or unexported fields
}
CreateConnectClusterOperation manages a long-running operation from CreateConnectCluster.
func (*CreateConnectClusterOperation) Done
func
(
op
*
CreateConnectClusterOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*CreateConnectClusterOperation) Metadata
func
(
op
*
CreateConnectClusterOperation
)
Metadata
()
(
*
managedkafkapb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*CreateConnectClusterOperation) Name
func
(
op
*
CreateConnectClusterOperation
)
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 (*CreateConnectClusterOperation) Poll
func
(
op
*
CreateConnectClusterOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
managedkafkapb
.
ConnectCluster
,
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 (*CreateConnectClusterOperation) Wait
func
(
op
*
CreateConnectClusterOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
managedkafkapb
.
ConnectCluster
,
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) Done
func
(
op
*
DeleteClusterOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*DeleteClusterOperation) Metadata
func
(
op
*
DeleteClusterOperation
)
Metadata
()
(
*
managedkafkapb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*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.
DeleteConnectClusterOperation
type
DeleteConnectClusterOperation
struct
{
// contains filtered or unexported fields
}
DeleteConnectClusterOperation manages a long-running operation from DeleteConnectCluster.
func (*DeleteConnectClusterOperation) Done
func
(
op
*
DeleteConnectClusterOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*DeleteConnectClusterOperation) Metadata
func
(
op
*
DeleteConnectClusterOperation
)
Metadata
()
(
*
managedkafkapb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DeleteConnectClusterOperation) Name
func
(
op
*
DeleteConnectClusterOperation
)
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 (*DeleteConnectClusterOperation) Poll
func
(
op
*
DeleteConnectClusterOperation
)
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 (*DeleteConnectClusterOperation) Wait
func
(
op
*
DeleteConnectClusterOperation
)
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.
LocationIterator
type
LocationIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
locationpb
.
Location
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
LocationIterator manages a stream of *locationpb.Location.
func (*LocationIterator) All
func
(
it
*
LocationIterator
)
All
()
iter
.
Seq2
[
*
locationpb
.
Location
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*LocationIterator) Next
func
(
it
*
LocationIterator
)
Next
()
(
*
locationpb
.
Location
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*LocationIterator) PageInfo
func
(
it
*
LocationIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
ManagedKafkaConnectCallOptions
type
ManagedKafkaConnectCallOptions
struct
{
ListConnectClusters
[]
gax
.
CallOption
GetConnectCluster
[]
gax
.
CallOption
CreateConnectCluster
[]
gax
.
CallOption
UpdateConnectCluster
[]
gax
.
CallOption
DeleteConnectCluster
[]
gax
.
CallOption
ListConnectors
[]
gax
.
CallOption
GetConnector
[]
gax
.
CallOption
CreateConnector
[]
gax
.
CallOption
UpdateConnector
[]
gax
.
CallOption
DeleteConnector
[]
gax
.
CallOption
PauseConnector
[]
gax
.
CallOption
ResumeConnector
[]
gax
.
CallOption
RestartConnector
[]
gax
.
CallOption
StopConnector
[]
gax
.
CallOption
GetLocation
[]
gax
.
CallOption
ListLocations
[]
gax
.
CallOption
CancelOperation
[]
gax
.
CallOption
DeleteOperation
[]
gax
.
CallOption
GetOperation
[]
gax
.
CallOption
ListOperations
[]
gax
.
CallOption
}
ManagedKafkaConnectCallOptions contains the retry settings for each method of ManagedKafkaConnectClient.
ManagedKafkaConnectClient
type
ManagedKafkaConnectClient
struct
{
// The call options for this service.
CallOptions
*
ManagedKafkaConnectCallOptions
// 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
}
ManagedKafkaConnectClient is a client for interacting with Managed Service for Apache Kafka API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
The service that a client application uses to manage Apache Kafka Connect clusters and connectors.
func NewManagedKafkaConnectClient
func
NewManagedKafkaConnectClient
(
ctx
context
.
Context
,
opts
...
option
.
ClientOption
)
(
*
ManagedKafkaConnectClient
,
error
)
NewManagedKafkaConnectClient creates a new managed kafka connect client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
The service that a client application uses to manage Apache Kafka Connect clusters and connectors.
Example
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/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
:=
managedkafka
.
NewManagedKafkaConnectClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func NewManagedKafkaConnectRESTClient
func
NewManagedKafkaConnectRESTClient
(
ctx
context
.
Context
,
opts
...
option
.
ClientOption
)
(
*
ManagedKafkaConnectClient
,
error
)
NewManagedKafkaConnectRESTClient creates a new managed kafka connect rest client.
The service that a client application uses to manage Apache Kafka Connect clusters and connectors.
Example
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/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
:=
managedkafka
.
NewManagedKafkaConnectRESTClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func (*ManagedKafkaConnectClient) CancelOperation
func
(
c
*
ManagedKafkaConnectClient
)
CancelOperation
(
ctx
context
.
Context
,
req
*
longrunningpb
.
CancelOperationRequest
,
opts
...
gax
.
CallOption
)
error
CancelOperation is a utility method from google.longrunning.Operations.
Example
package
main
import
(
"context"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
managedkafka
"cloud.google.com/go/managedkafka/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
:=
managedkafka
.
NewManagedKafkaConnectClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& longrunningpb
.
CancelOperationRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#CancelOperationRequest.
}
err
=
c
.
CancelOperation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*ManagedKafkaConnectClient) Close
func
(
c
*
ManagedKafkaConnectClient
)
Close
()
error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*ManagedKafkaConnectClient) Connection (deprecated)
func
(
c
*
ManagedKafkaConnectClient
)
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 (*ManagedKafkaConnectClient) CreateConnectCluster
func
(
c
*
ManagedKafkaConnectClient
)
CreateConnectCluster
(
ctx
context
.
Context
,
req
*
managedkafkapb
.
CreateConnectClusterRequest
,
opts
...
gax
.
CallOption
)
(
*
CreateConnectClusterOperation
,
error
)
CreateConnectCluster creates a new Kafka Connect cluster in a given project and location.
Example
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
)
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
:=
managedkafka
.
NewManagedKafkaConnectClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
CreateConnectClusterRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#CreateConnectClusterRequest.
}
op
,
err
:=
c
.
CreateConnectCluster
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*ManagedKafkaConnectClient) CreateConnectClusterOperation
func
(
c
*
ManagedKafkaConnectClient
)
CreateConnectClusterOperation
(
name
string
)
*
CreateConnectClusterOperation
CreateConnectClusterOperation returns a new CreateConnectClusterOperation from a given name. The name must be that of a previously created CreateConnectClusterOperation, possibly from a different process.
func (*ManagedKafkaConnectClient) CreateConnector
func
(
c
*
ManagedKafkaConnectClient
)
CreateConnector
(
ctx
context
.
Context
,
req
*
managedkafkapb
.
CreateConnectorRequest
,
opts
...
gax
.
CallOption
)
(
*
managedkafkapb
.
Connector
,
error
)
CreateConnector creates a new connector in a given Connect cluster.
Example
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
)
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
:=
managedkafka
.
NewManagedKafkaConnectClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
CreateConnectorRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#CreateConnectorRequest.
}
resp
,
err
:=
c
.
CreateConnector
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*ManagedKafkaConnectClient) DeleteConnectCluster
func
(
c
*
ManagedKafkaConnectClient
)
DeleteConnectCluster
(
ctx
context
.
Context
,
req
*
managedkafkapb
.
DeleteConnectClusterRequest
,
opts
...
gax
.
CallOption
)
(
*
DeleteConnectClusterOperation
,
error
)
DeleteConnectCluster deletes a single Connect cluster.
Example
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
)
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
:=
managedkafka
.
NewManagedKafkaConnectClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
DeleteConnectClusterRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#DeleteConnectClusterRequest.
}
op
,
err
:=
c
.
DeleteConnectCluster
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
err
=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*ManagedKafkaConnectClient) DeleteConnectClusterOperation
func
(
c
*
ManagedKafkaConnectClient
)
DeleteConnectClusterOperation
(
name
string
)
*
DeleteConnectClusterOperation
DeleteConnectClusterOperation returns a new DeleteConnectClusterOperation from a given name. The name must be that of a previously created DeleteConnectClusterOperation, possibly from a different process.
func (*ManagedKafkaConnectClient) DeleteConnector
func
(
c
*
ManagedKafkaConnectClient
)
DeleteConnector
(
ctx
context
.
Context
,
req
*
managedkafkapb
.
DeleteConnectorRequest
,
opts
...
gax
.
CallOption
)
error
DeleteConnector deletes a connector.
Example
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
)
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
:=
managedkafka
.
NewManagedKafkaConnectClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
DeleteConnectorRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#DeleteConnectorRequest.
}
err
=
c
.
DeleteConnector
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*ManagedKafkaConnectClient) DeleteOperation
func
(
c
*
ManagedKafkaConnectClient
)
DeleteOperation
(
ctx
context
.
Context
,
req
*
longrunningpb
.
DeleteOperationRequest
,
opts
...
gax
.
CallOption
)
error
DeleteOperation is a utility method from google.longrunning.Operations.
Example
package
main
import
(
"context"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
managedkafka
"cloud.google.com/go/managedkafka/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
:=
managedkafka
.
NewManagedKafkaConnectClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& longrunningpb
.
DeleteOperationRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#DeleteOperationRequest.
}
err
=
c
.
DeleteOperation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*ManagedKafkaConnectClient) GetConnectCluster
func
(
c
*
ManagedKafkaConnectClient
)
GetConnectCluster
(
ctx
context
.
Context
,
req
*
managedkafkapb
.
GetConnectClusterRequest
,
opts
...
gax
.
CallOption
)
(
*
managedkafkapb
.
ConnectCluster
,
error
)
GetConnectCluster returns the properties of a single Kafka Connect cluster.
Example
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
)
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
:=
managedkafka
.
NewManagedKafkaConnectClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
GetConnectClusterRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#GetConnectClusterRequest.
}
resp
,
err
:=
c
.
GetConnectCluster
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*ManagedKafkaConnectClient) GetConnector
func
(
c
*
ManagedKafkaConnectClient
)
GetConnector
(
ctx
context
.
Context
,
req
*
managedkafkapb
.
GetConnectorRequest
,
opts
...
gax
.
CallOption
)
(
*
managedkafkapb
.
Connector
,
error
)
GetConnector returns the properties of a single connector.
Example
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
)
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
:=
managedkafka
.
NewManagedKafkaConnectClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
GetConnectorRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#GetConnectorRequest.
}
resp
,
err
:=
c
.
GetConnector
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*ManagedKafkaConnectClient) GetLocation
func
(
c
*
ManagedKafkaConnectClient
)
GetLocation
(
ctx
context
.
Context
,
req
*
locationpb
.
GetLocationRequest
,
opts
...
gax
.
CallOption
)
(
*
locationpb
.
Location
,
error
)
GetLocation gets information about a location.
Example
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
locationpb
"google.golang.org/genproto/googleapis/cloud/location"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
managedkafka
.
NewManagedKafkaConnectClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& locationpb
.
GetLocationRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#GetLocationRequest.
}
resp
,
err
:=
c
.
GetLocation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*ManagedKafkaConnectClient) GetOperation
func
(
c
*
ManagedKafkaConnectClient
)
GetOperation
(
ctx
context
.
Context
,
req
*
longrunningpb
.
GetOperationRequest
,
opts
...
gax
.
CallOption
)
(
*
longrunningpb
.
Operation
,
error
)
GetOperation is a utility method from google.longrunning.Operations.
Example
package
main
import
(
"context"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
managedkafka
"cloud.google.com/go/managedkafka/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
:=
managedkafka
.
NewManagedKafkaConnectClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& longrunningpb
.
GetOperationRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest.
}
resp
,
err
:=
c
.
GetOperation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*ManagedKafkaConnectClient) ListConnectClusters
func
(
c
*
ManagedKafkaConnectClient
)
ListConnectClusters
(
ctx
context
.
Context
,
req
*
managedkafkapb
.
ListConnectClustersRequest
,
opts
...
gax
.
CallOption
)
*
ConnectClusterIterator
ListConnectClusters lists the Kafka Connect clusters in a given project and location.
Examples
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
"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
:=
managedkafka
.
NewManagedKafkaConnectClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
ListConnectClustersRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#ListConnectClustersRequest.
}
it
:=
c
.
ListConnectClusters
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
managedkafkapb
.
ListConnectClustersResponse
)
}
}
all
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
)
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
:=
managedkafka
.
NewManagedKafkaConnectClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
ListConnectClustersRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#ListConnectClustersRequest.
}
for
resp
,
err
:=
range
c
.
ListConnectClusters
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*ManagedKafkaConnectClient) ListConnectors
func
(
c
*
ManagedKafkaConnectClient
)
ListConnectors
(
ctx
context
.
Context
,
req
*
managedkafkapb
.
ListConnectorsRequest
,
opts
...
gax
.
CallOption
)
*
ConnectorIterator
ListConnectors lists the connectors in a given Connect cluster.
Examples
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
"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
:=
managedkafka
.
NewManagedKafkaConnectClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
ListConnectorsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#ListConnectorsRequest.
}
it
:=
c
.
ListConnectors
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
managedkafkapb
.
ListConnectorsResponse
)
}
}
all
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
)
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
:=
managedkafka
.
NewManagedKafkaConnectClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
ListConnectorsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#ListConnectorsRequest.
}
for
resp
,
err
:=
range
c
.
ListConnectors
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*ManagedKafkaConnectClient) ListLocations
func
(
c
*
ManagedKafkaConnectClient
)
ListLocations
(
ctx
context
.
Context
,
req
*
locationpb
.
ListLocationsRequest
,
opts
...
gax
.
CallOption
)
*
LocationIterator
ListLocations lists information about the supported locations for this service.
Examples
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
"google.golang.org/api/iterator"
locationpb
"google.golang.org/genproto/googleapis/cloud/location"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
managedkafka
.
NewManagedKafkaConnectClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& locationpb
.
ListLocationsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.
}
it
:=
c
.
ListLocations
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
locationpb
.
ListLocationsResponse
)
}
}
all
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
locationpb
"google.golang.org/genproto/googleapis/cloud/location"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
managedkafka
.
NewManagedKafkaConnectClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& locationpb
.
ListLocationsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.
}
for
resp
,
err
:=
range
c
.
ListLocations
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*ManagedKafkaConnectClient) ListOperations
func
(
c
*
ManagedKafkaConnectClient
)
ListOperations
(
ctx
context
.
Context
,
req
*
longrunningpb
.
ListOperationsRequest
,
opts
...
gax
.
CallOption
)
*
OperationIterator
ListOperations is a utility method from google.longrunning.Operations.
Examples
package
main
import
(
"context"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
"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
:=
managedkafka
.
NewManagedKafkaConnectClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& longrunningpb
.
ListOperationsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
it
:=
c
.
ListOperations
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
longrunningpb
.
ListOperationsResponse
)
}
}
all
package
main
import
(
"context"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
managedkafka
"cloud.google.com/go/managedkafka/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
:=
managedkafka
.
NewManagedKafkaConnectClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& longrunningpb
.
ListOperationsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
for
resp
,
err
:=
range
c
.
ListOperations
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*ManagedKafkaConnectClient) PauseConnector
func
(
c
*
ManagedKafkaConnectClient
)
PauseConnector
(
ctx
context
.
Context
,
req
*
managedkafkapb
.
PauseConnectorRequest
,
opts
...
gax
.
CallOption
)
(
*
managedkafkapb
.
PauseConnectorResponse
,
error
)
PauseConnector pauses the connector and its tasks.
Example
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
)
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
:=
managedkafka
.
NewManagedKafkaConnectClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
PauseConnectorRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#PauseConnectorRequest.
}
resp
,
err
:=
c
.
PauseConnector
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*ManagedKafkaConnectClient) RestartConnector
func
(
c
*
ManagedKafkaConnectClient
)
RestartConnector
(
ctx
context
.
Context
,
req
*
managedkafkapb
.
RestartConnectorRequest
,
opts
...
gax
.
CallOption
)
(
*
managedkafkapb
.
RestartConnectorResponse
,
error
)
RestartConnector restarts the connector.
Example
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
)
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
:=
managedkafka
.
NewManagedKafkaConnectClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
RestartConnectorRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#RestartConnectorRequest.
}
resp
,
err
:=
c
.
RestartConnector
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*ManagedKafkaConnectClient) ResumeConnector
func
(
c
*
ManagedKafkaConnectClient
)
ResumeConnector
(
ctx
context
.
Context
,
req
*
managedkafkapb
.
ResumeConnectorRequest
,
opts
...
gax
.
CallOption
)
(
*
managedkafkapb
.
ResumeConnectorResponse
,
error
)
ResumeConnector resumes the connector and its tasks.
Example
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
)
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
:=
managedkafka
.
NewManagedKafkaConnectClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
ResumeConnectorRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#ResumeConnectorRequest.
}
resp
,
err
:=
c
.
ResumeConnector
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*ManagedKafkaConnectClient) StopConnector
func
(
c
*
ManagedKafkaConnectClient
)
StopConnector
(
ctx
context
.
Context
,
req
*
managedkafkapb
.
StopConnectorRequest
,
opts
...
gax
.
CallOption
)
(
*
managedkafkapb
.
StopConnectorResponse
,
error
)
StopConnector stops the connector.
Example
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
)
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
:=
managedkafka
.
NewManagedKafkaConnectClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
StopConnectorRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#StopConnectorRequest.
}
resp
,
err
:=
c
.
StopConnector
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*ManagedKafkaConnectClient) UpdateConnectCluster
func
(
c
*
ManagedKafkaConnectClient
)
UpdateConnectCluster
(
ctx
context
.
Context
,
req
*
managedkafkapb
.
UpdateConnectClusterRequest
,
opts
...
gax
.
CallOption
)
(
*
UpdateConnectClusterOperation
,
error
)
UpdateConnectCluster updates the properties of a single Kafka Connect cluster.
Example
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
)
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
:=
managedkafka
.
NewManagedKafkaConnectClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
UpdateConnectClusterRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#UpdateConnectClusterRequest.
}
op
,
err
:=
c
.
UpdateConnectCluster
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*ManagedKafkaConnectClient) UpdateConnectClusterOperation
func
(
c
*
ManagedKafkaConnectClient
)
UpdateConnectClusterOperation
(
name
string
)
*
UpdateConnectClusterOperation
UpdateConnectClusterOperation returns a new UpdateConnectClusterOperation from a given name. The name must be that of a previously created UpdateConnectClusterOperation, possibly from a different process.
func (*ManagedKafkaConnectClient) UpdateConnector
func
(
c
*
ManagedKafkaConnectClient
)
UpdateConnector
(
ctx
context
.
Context
,
req
*
managedkafkapb
.
UpdateConnectorRequest
,
opts
...
gax
.
CallOption
)
(
*
managedkafkapb
.
Connector
,
error
)
UpdateConnector updates the properties of a connector.
Example
package
main
import
(
"context"
managedkafka
"cloud.google.com/go/managedkafka/apiv1"
managedkafkapb
"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
)
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
:=
managedkafka
.
NewManagedKafkaConnectClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& managedkafkapb
.
UpdateConnectorRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/managedkafka/apiv1/managedkafkapb#UpdateConnectorRequest.
}
resp
,
err
:=
c
.
UpdateConnector
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
OperationIterator
type
OperationIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
longrunningpb
.
Operation
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
OperationIterator manages a stream of *longrunningpb.Operation.
func (*OperationIterator) All
func
(
it
*
OperationIterator
)
All
()
iter
.
Seq2
[
*
longrunningpb
.
Operation
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*OperationIterator) Next
func
(
it
*
OperationIterator
)
Next
()
(
*
longrunningpb
.
Operation
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*OperationIterator) PageInfo
func
(
it
*
OperationIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
TopicIterator
type
TopicIterator
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
[]
*
managedkafkapb
.
Topic
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
TopicIterator manages a stream of *managedkafkapb.Topic.
func (*TopicIterator) All
func
(
it
*
TopicIterator
)
All
()
iter
.
Seq2
[
*
managedkafkapb
.
Topic
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*TopicIterator) Next
func
(
it
*
TopicIterator
)
Next
()
(
*
managedkafkapb
.
Topic
,
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 (*TopicIterator) PageInfo
func
(
it
*
TopicIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
UpdateClusterOperation
type
UpdateClusterOperation
struct
{
// contains filtered or unexported fields
}
UpdateClusterOperation manages a long-running operation from UpdateCluster.
func (*UpdateClusterOperation) Done
func
(
op
*
UpdateClusterOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*UpdateClusterOperation) Metadata
func
(
op
*
UpdateClusterOperation
)
Metadata
()
(
*
managedkafkapb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*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
)
(
*
managedkafkapb
.
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
)
(
*
managedkafkapb
.
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.
UpdateConnectClusterOperation
type
UpdateConnectClusterOperation
struct
{
// contains filtered or unexported fields
}
UpdateConnectClusterOperation manages a long-running operation from UpdateConnectCluster.
func (*UpdateConnectClusterOperation) Done
func
(
op
*
UpdateConnectClusterOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*UpdateConnectClusterOperation) Metadata
func
(
op
*
UpdateConnectClusterOperation
)
Metadata
()
(
*
managedkafkapb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UpdateConnectClusterOperation) Name
func
(
op
*
UpdateConnectClusterOperation
)
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 (*UpdateConnectClusterOperation) Poll
func
(
op
*
UpdateConnectClusterOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
managedkafkapb
.
ConnectCluster
,
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 (*UpdateConnectClusterOperation) Wait
func
(
op
*
UpdateConnectClusterOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
managedkafkapb
.
ConnectCluster
,
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.
