Class: Google::Cloud::ManagedKafka::V1::ManagedKafkaConnect::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/managed_kafka/v1/managed_kafka_connect/client.rb

Overview

Client for the ManagedKafkaConnect service.

The service that a client application uses to manage Apache Kafka Connect clusters and connectors.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#connect_cluster_path, #connector_path, #location_path, #secret_version_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new ManagedKafkaConnect client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::ManagedKafka::V1::ManagedKafkaConnect::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::ManagedKafka::V1::ManagedKafkaConnect::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the ManagedKafkaConnect client.

Yield Parameters:



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/google/cloud/managed_kafka/v1/managed_kafka_connect/client.rb', line 166

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/managedkafka/v1/managed_kafka_connect_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @managed_kafka_connect_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::ManagedKafka::V1::ManagedKafkaConnect::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @managed_kafka_connect_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end

  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @managed_kafka_connect_stub.endpoint
    config.universe_domain = @managed_kafka_connect_stub.universe_domain
    config.logger = @managed_kafka_connect_stub.logger if config.respond_to? :logger=
  end
end

Instance Attribute Details

#location_client ⇒ Google::Cloud::Location::Locations::Client (readonly)

Get the associated client for mix-in of the Locations.

Returns:

  • (Google::Cloud::Location::Locations::Client) 


244
245
246
 
# File 'lib/google/cloud/managed_kafka/v1/managed_kafka_connect/client.rb', line 244

def location_client
  @location_client
end

#operations_client ⇒ ::Google::Cloud::ManagedKafka::V1::ManagedKafkaConnect::Operations (readonly)

Get the associated client for long-running operations.

Returns:



237
238
239
 
# File 'lib/google/cloud/managed_kafka/v1/managed_kafka_connect/client.rb', line 237

def operations_client
  @operations_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the ManagedKafkaConnect Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all ManagedKafkaConnect clients
::Google::Cloud::ManagedKafka::V1::ManagedKafkaConnect::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/google/cloud/managed_kafka/v1/managed_kafka_connect/client.rb', line 64

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "ManagedKafka", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.list_connect_clusters.timeout = 60.0
    default_config.rpcs.list_connect_clusters.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_connect_cluster.timeout = 60.0
    default_config.rpcs.get_connect_cluster.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.create_connect_cluster.timeout = 60.0

    default_config.rpcs.update_connect_cluster.timeout = 60.0

    default_config.rpcs.delete_connect_cluster.timeout = 60.0

    default_config.rpcs.list_connectors.timeout = 60.0
    default_config.rpcs.list_connectors.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_connector.timeout = 60.0
    default_config.rpcs.get_connector.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.create_connector.timeout = 60.0

    default_config.rpcs.update_connector.timeout = 60.0

    default_config.rpcs.delete_connector.timeout = 60.0

    default_config.rpcs.pause_connector.timeout = 60.0

    default_config.rpcs.resume_connector.timeout = 60.0

    default_config.rpcs.restart_connector.timeout = 60.0

    default_config.rpcs.stop_connector.timeout = 60.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

Configure the ManagedKafkaConnect Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



136
137
138
139
 
# File 'lib/google/cloud/managed_kafka/v1/managed_kafka_connect/client.rb', line 136

def configure
  yield @config if block_given?
  @config
end

#create_connect_cluster(request, options = nil) ⇒ ::Gapic::Operation #create_connect_cluster(parent: nil, connect_cluster_id: nil, connect_cluster: nil, request_id: nil) ⇒ ::Gapic::Operation

Creates a new Kafka Connect cluster in a given project and location.

Examples:

Basic example

require "google/cloud/managed_kafka/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::V1::ManagedKafkaConnect::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::V1::CreateConnectClusterRequest.new

# Call the create_connect_cluster method.
result = client.create_connect_cluster request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #create_connect_cluster(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to create_connect_cluster via a request object, either of type CreateConnectClusterRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::ManagedKafka::V1::CreateConnectClusterRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_connect_cluster(parent: nil, connect_cluster_id: nil, connect_cluster: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_connect_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent project/location in which to create the Kafka Connect cluster. Structured like projects/{project}/locations/{location}/.

    • connect_cluster_id (::String) (defaults to: nil) —

      Required. The ID to use for the Connect cluster, which will become the final component of the cluster's name. The ID must be 1-63 characters long, and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? to comply with RFC 1035.

      This value is structured like: my-cluster-id.

    • connect_cluster (::Google::Cloud::ManagedKafka::V1::ConnectCluster, ::Hash) (defaults to: nil) —

      Required. Configuration of the Kafka Connect cluster to create. Its name field is ignored.

    • request_id (::String) (defaults to: nil) —

      Optional. An optional request ID to identify requests. Specify a unique request ID to avoid duplication of requests. If a request times out or fails, retrying with the same ID allows the server to recognize the previous attempt. For at least 60 minutes, the server ignores duplicate requests bearing the same ID.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID within 60 minutes of the last request, the server checks if an original operation with the same request ID was received. If so, the server ignores the second request.

      The request ID must be a valid UUID. A zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
 
# File 'lib/google/cloud/managed_kafka/v1/managed_kafka_connect/client.rb', line 528

def create_connect_cluster request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ManagedKafka::V1::CreateConnectClusterRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_connect_cluster.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ManagedKafka::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_connect_cluster.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_connect_cluster.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @managed_kafka_connect_stub.call_rpc :create_connect_cluster, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_connector(request, options = nil) ⇒ ::Google::Cloud::ManagedKafka::V1::Connector #create_connector(parent: nil, connector_id: nil, connector: nil) ⇒ ::Google::Cloud::ManagedKafka::V1::Connector

Creates a new connector in a given Connect cluster.

Examples:

Basic example

require "google/cloud/managed_kafka/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::V1::ManagedKafkaConnect::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::V1::CreateConnectorRequest.new

# Call the create_connector method.
result = client.create_connector request

# The returned object is of type Google::Cloud::ManagedKafka::V1::Connector.
p result

Overloads:

  • #create_connector(request, options = nil) ⇒ ::Google::Cloud::ManagedKafka::V1::Connector

    Pass arguments to create_connector via a request object, either of type CreateConnectorRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::ManagedKafka::V1::CreateConnectorRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_connector(parent: nil, connector_id: nil, connector: nil) ⇒ ::Google::Cloud::ManagedKafka::V1::Connector

    Pass arguments to create_connector via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent Connect cluster in which to create the connector. Structured like projects/{project}/locations/{location}/connectClusters/{connect_cluster_id}.

    • connector_id (::String) (defaults to: nil) —

      Required. The ID to use for the connector, which will become the final component of the connector's name. The ID must be 1-63 characters long, and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? to comply with RFC 1035.

      This value is structured like: my-connector-id.

    • connector (::Google::Cloud::ManagedKafka::V1::Connector, ::Hash) (defaults to: nil) —

      Required. The connector to create.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
 
# File 'lib/google/cloud/managed_kafka/v1/managed_kafka_connect/client.rb', line 1043

def create_connector request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ManagedKafka::V1::CreateConnectorRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_connector.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ManagedKafka::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_connector.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_connector.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @managed_kafka_connect_stub.call_rpc :create_connector, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_connect_cluster(request, options = nil) ⇒ ::Gapic::Operation #delete_connect_cluster(name: nil, request_id: nil) ⇒ ::Gapic::Operation

Deletes a single Connect cluster.

Examples:

Basic example

require "google/cloud/managed_kafka/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::V1::ManagedKafkaConnect::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::V1::DeleteConnectClusterRequest.new

# Call the delete_connect_cluster method.
result = client.delete_connect_cluster request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #delete_connect_cluster(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_connect_cluster via a request object, either of type DeleteConnectClusterRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::ManagedKafka::V1::DeleteConnectClusterRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_connect_cluster(name: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_connect_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the Kafka Connect cluster to delete. Structured like projects/{project}/locations/{location}/connectClusters/{connect_cluster_id}.

    • request_id (::String) (defaults to: nil) —

      Optional. An optional request ID to identify requests. Specify a unique request ID to avoid duplication of requests. If a request times out or fails, retrying with the same ID allows the server to recognize the previous attempt. For at least 60 minutes, the server ignores duplicate requests bearing the same ID.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID within 60 minutes of the last request, the server checks if an original operation with the same request ID was received. If so, the server ignores the second request.

      The request ID must be a valid UUID. A zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
 
# File 'lib/google/cloud/managed_kafka/v1/managed_kafka_connect/client.rb', line 755

def delete_connect_cluster request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ManagedKafka::V1::DeleteConnectClusterRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_connect_cluster.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ManagedKafka::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_connect_cluster.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_connect_cluster.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @managed_kafka_connect_stub.call_rpc :delete_connect_cluster, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_connector(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_connector(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes a connector.

Examples:

Basic example

require "google/cloud/managed_kafka/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::V1::ManagedKafkaConnect::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::V1::DeleteConnectorRequest.new

# Call the delete_connector method.
result = client.delete_connector request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #delete_connector(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_connector via a request object, either of type DeleteConnectorRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::ManagedKafka::V1::DeleteConnectorRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_connector(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_connector via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the connector to delete. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector}

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
 
# File 'lib/google/cloud/managed_kafka/v1/managed_kafka_connect/client.rb', line 1221

def delete_connector request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ManagedKafka::V1::DeleteConnectorRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_connector.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ManagedKafka::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_connector.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_connector.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @managed_kafka_connect_stub.call_rpc :delete_connector, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_connect_cluster(request, options = nil) ⇒ ::Google::Cloud::ManagedKafka::V1::ConnectCluster #get_connect_cluster(name: nil) ⇒ ::Google::Cloud::ManagedKafka::V1::ConnectCluster

Returns the properties of a single Kafka Connect cluster.

Examples:

Basic example

require "google/cloud/managed_kafka/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::V1::ManagedKafkaConnect::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::V1::GetConnectClusterRequest.new

# Call the get_connect_cluster method.
result = client.get_connect_cluster request

# The returned object is of type Google::Cloud::ManagedKafka::V1::ConnectCluster.
p result

Overloads:

  • #get_connect_cluster(request, options = nil) ⇒ ::Google::Cloud::ManagedKafka::V1::ConnectCluster

    Pass arguments to get_connect_cluster via a request object, either of type GetConnectClusterRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::ManagedKafka::V1::GetConnectClusterRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_connect_cluster(name: nil) ⇒ ::Google::Cloud::ManagedKafka::V1::ConnectCluster

    Pass arguments to get_connect_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the Kafka Connect cluster whose configuration to return. Structured like projects/{project}/locations/{location}/connectClusters/{connect_cluster_id}.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/google/cloud/managed_kafka/v1/managed_kafka_connect/client.rb', line 409

def get_connect_cluster request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ManagedKafka::V1::GetConnectClusterRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_connect_cluster.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ManagedKafka::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_connect_cluster.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_connect_cluster.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @managed_kafka_connect_stub.call_rpc :get_connect_cluster, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_connector(request, options = nil) ⇒ ::Google::Cloud::ManagedKafka::V1::Connector #get_connector(name: nil) ⇒ ::Google::Cloud::ManagedKafka::V1::Connector

Returns the properties of a single connector.

Examples:

Basic example

require "google/cloud/managed_kafka/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::V1::ManagedKafkaConnect::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::V1::GetConnectorRequest.new

# Call the get_connector method.
result = client.get_connector request

# The returned object is of type Google::Cloud::ManagedKafka::V1::Connector.
p result

Overloads:

  • #get_connector(request, options = nil) ⇒ ::Google::Cloud::ManagedKafka::V1::Connector

    Pass arguments to get_connector via a request object, either of type GetConnectorRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::ManagedKafka::V1::GetConnectorRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_connector(name: nil) ⇒ ::Google::Cloud::ManagedKafka::V1::Connector

    Pass arguments to get_connector via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the connector whose configuration to return. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector}

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
 
# File 'lib/google/cloud/managed_kafka/v1/managed_kafka_connect/client.rb', line 947

def get_connector request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ManagedKafka::V1::GetConnectorRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_connector.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ManagedKafka::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_connector.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_connector.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @managed_kafka_connect_stub.call_rpc :get_connector, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_connect_clusters(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::ManagedKafka::V1::ConnectCluster> #list_connect_clusters(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::ManagedKafka::V1::ConnectCluster>

Lists the Kafka Connect clusters in a given project and location.

Examples:

Basic example

require "google/cloud/managed_kafka/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::V1::ManagedKafkaConnect::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::V1::ListConnectClustersRequest.new

# Call the list_connect_clusters method.
result = client.list_connect_clusters request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::ManagedKafka::V1::ConnectCluster.
  p item
end

Overloads:

  • #list_connect_clusters(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::ManagedKafka::V1::ConnectCluster>

    Pass arguments to list_connect_clusters via a request object, either of type ListConnectClustersRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::ManagedKafka::V1::ListConnectClustersRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_connect_clusters(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::ManagedKafka::V1::ConnectCluster>

    Pass arguments to list_connect_clusters via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent project/location whose Connect clusters are to be listed. Structured like projects/{project}/locations/{location}.

    • page_size (::Integer) (defaults to: nil) —

      Optional. The maximum number of Connect clusters to return. The service may return fewer than this value. If unspecified, server will pick an appropriate default.

    • page_token (::String) (defaults to: nil) —

      Optional. A page token, received from a previous ListConnectClusters call. Provide this to retrieve the subsequent page.

      When paginating, all other parameters provided to ListConnectClusters must match the call that provided the page token.

    • filter (::String) (defaults to: nil) —

      Optional. Filter expression for the result.

    • order_by (::String) (defaults to: nil) —

      Optional. Order by fields for the result.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/google/cloud/managed_kafka/v1/managed_kafka_connect/client.rb', line 320

def list_connect_clusters request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ManagedKafka::V1::ListConnectClustersRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_connect_clusters.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ManagedKafka::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_connect_clusters.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_connect_clusters.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @managed_kafka_connect_stub.call_rpc :list_connect_clusters, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @managed_kafka_connect_stub, :list_connect_clusters, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_connectors(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::ManagedKafka::V1::Connector> #list_connectors(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::ManagedKafka::V1::Connector>

Lists the connectors in a given Connect cluster.

Examples:

Basic example

require "google/cloud/managed_kafka/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::V1::ManagedKafkaConnect::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::V1::ListConnectorsRequest.new

# Call the list_connectors method.
result = client.list_connectors request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::ManagedKafka::V1::Connector.
  p item
end

Overloads:

  • #list_connectors(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::ManagedKafka::V1::Connector>

    Pass arguments to list_connectors via a request object, either of type ListConnectorsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::ManagedKafka::V1::ListConnectorsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_connectors(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::ManagedKafka::V1::Connector>

    Pass arguments to list_connectors via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent Connect cluster whose connectors are to be listed. Structured like projects/{project}/locations/{location}/connectClusters/{connect_cluster_id}.

    • page_size (::Integer) (defaults to: nil) —

      Optional. The maximum number of connectors to return. The service may return fewer than this value. If unspecified, server will pick an appropriate default.

    • page_token (::String) (defaults to: nil) —

      Optional. A page token, received from a previous ListConnectors call. Provide this to retrieve the subsequent page.

      When paginating, all other parameters provided to ListConnectors must match the call that provided the page token.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
 
# File 'lib/google/cloud/managed_kafka/v1/managed_kafka_connect/client.rb', line 858

def list_connectors request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ManagedKafka::V1::ListConnectorsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_connectors.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ManagedKafka::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_connectors.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_connectors.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @managed_kafka_connect_stub.call_rpc :list_connectors, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @managed_kafka_connect_stub, :list_connectors, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


251
252
253
 
# File 'lib/google/cloud/managed_kafka/v1/managed_kafka_connect/client.rb', line 251

def logger
  @managed_kafka_connect_stub.logger
end

#pause_connector(request, options = nil) ⇒ ::Google::Cloud::ManagedKafka::V1::PauseConnectorResponse #pause_connector(name: nil) ⇒ ::Google::Cloud::ManagedKafka::V1::PauseConnectorResponse

Pauses the connector and its tasks.

Examples:

Basic example

require "google/cloud/managed_kafka/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::V1::ManagedKafkaConnect::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::V1::PauseConnectorRequest.new

# Call the pause_connector method.
result = client.pause_connector request

# The returned object is of type Google::Cloud::ManagedKafka::V1::PauseConnectorResponse.
p result

Overloads:

  • #pause_connector(request, options = nil) ⇒ ::Google::Cloud::ManagedKafka::V1::PauseConnectorResponse

    Pass arguments to pause_connector via a request object, either of type PauseConnectorRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::ManagedKafka::V1::PauseConnectorRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #pause_connector(name: nil) ⇒ ::Google::Cloud::ManagedKafka::V1::PauseConnectorResponse

    Pass arguments to pause_connector via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the connector to pause. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector}

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
 
# File 'lib/google/cloud/managed_kafka/v1/managed_kafka_connect/client.rb', line 1308

def pause_connector request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ManagedKafka::V1::PauseConnectorRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.pause_connector.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ManagedKafka::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.pause_connector.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.pause_connector.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @managed_kafka_connect_stub.call_rpc :pause_connector, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#restart_connector(request, options = nil) ⇒ ::Google::Cloud::ManagedKafka::V1::RestartConnectorResponse #restart_connector(name: nil) ⇒ ::Google::Cloud::ManagedKafka::V1::RestartConnectorResponse

Restarts the connector.

Examples:

Basic example

require "google/cloud/managed_kafka/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::V1::ManagedKafkaConnect::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::V1::RestartConnectorRequest.new

# Call the restart_connector method.
result = client.restart_connector request

# The returned object is of type Google::Cloud::ManagedKafka::V1::RestartConnectorResponse.
p result

Overloads:

  • #restart_connector(request, options = nil) ⇒ ::Google::Cloud::ManagedKafka::V1::RestartConnectorResponse

    Pass arguments to restart_connector via a request object, either of type RestartConnectorRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::ManagedKafka::V1::RestartConnectorRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #restart_connector(name: nil) ⇒ ::Google::Cloud::ManagedKafka::V1::RestartConnectorResponse

    Pass arguments to restart_connector via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the connector to restart. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector}

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
 
# File 'lib/google/cloud/managed_kafka/v1/managed_kafka_connect/client.rb', line 1482

def restart_connector request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ManagedKafka::V1::RestartConnectorRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.restart_connector.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ManagedKafka::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.restart_connector.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.restart_connector.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @managed_kafka_connect_stub.call_rpc :restart_connector, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#resume_connector(request, options = nil) ⇒ ::Google::Cloud::ManagedKafka::V1::ResumeConnectorResponse #resume_connector(name: nil) ⇒ ::Google::Cloud::ManagedKafka::V1::ResumeConnectorResponse

Resumes the connector and its tasks.

Examples:

Basic example

require "google/cloud/managed_kafka/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::V1::ManagedKafkaConnect::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::V1::ResumeConnectorRequest.new

# Call the resume_connector method.
result = client.resume_connector request

# The returned object is of type Google::Cloud::ManagedKafka::V1::ResumeConnectorResponse.
p result

Overloads:

  • #resume_connector(request, options = nil) ⇒ ::Google::Cloud::ManagedKafka::V1::ResumeConnectorResponse

    Pass arguments to resume_connector via a request object, either of type ResumeConnectorRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::ManagedKafka::V1::ResumeConnectorRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #resume_connector(name: nil) ⇒ ::Google::Cloud::ManagedKafka::V1::ResumeConnectorResponse

    Pass arguments to resume_connector via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the connector to pause. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector}

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
 
# File 'lib/google/cloud/managed_kafka/v1/managed_kafka_connect/client.rb', line 1395

def resume_connector request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ManagedKafka::V1::ResumeConnectorRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.resume_connector.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ManagedKafka::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.resume_connector.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.resume_connector.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @managed_kafka_connect_stub.call_rpc :resume_connector, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#stop_connector(request, options = nil) ⇒ ::Google::Cloud::ManagedKafka::V1::StopConnectorResponse #stop_connector(name: nil) ⇒ ::Google::Cloud::ManagedKafka::V1::StopConnectorResponse

Stops the connector.

Examples:

Basic example

require "google/cloud/managed_kafka/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::V1::ManagedKafkaConnect::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::V1::StopConnectorRequest.new

# Call the stop_connector method.
result = client.stop_connector request

# The returned object is of type Google::Cloud::ManagedKafka::V1::StopConnectorResponse.
p result

Overloads:

  • #stop_connector(request, options = nil) ⇒ ::Google::Cloud::ManagedKafka::V1::StopConnectorResponse

    Pass arguments to stop_connector via a request object, either of type StopConnectorRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::ManagedKafka::V1::StopConnectorRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #stop_connector(name: nil) ⇒ ::Google::Cloud::ManagedKafka::V1::StopConnectorResponse

    Pass arguments to stop_connector via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the connector to stop. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector}

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
 
# File 'lib/google/cloud/managed_kafka/v1/managed_kafka_connect/client.rb', line 1569

def stop_connector request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ManagedKafka::V1::StopConnectorRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.stop_connector.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ManagedKafka::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.stop_connector.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.stop_connector.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @managed_kafka_connect_stub.call_rpc :stop_connector, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


146
147
148
 
# File 'lib/google/cloud/managed_kafka/v1/managed_kafka_connect/client.rb', line 146

def universe_domain
  @managed_kafka_connect_stub.universe_domain
end

#update_connect_cluster(request, options = nil) ⇒ ::Gapic::Operation #update_connect_cluster(update_mask: nil, connect_cluster: nil, request_id: nil) ⇒ ::Gapic::Operation

Updates the properties of a single Kafka Connect cluster.

Examples:

Basic example

require "google/cloud/managed_kafka/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::V1::ManagedKafkaConnect::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::V1::UpdateConnectClusterRequest.new

# Call the update_connect_cluster method.
result = client.update_connect_cluster request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #update_connect_cluster(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to update_connect_cluster via a request object, either of type UpdateConnectClusterRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::ManagedKafka::V1::UpdateConnectClusterRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_connect_cluster(update_mask: nil, connect_cluster: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to update_connect_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Required. Field mask is used to specify the fields to be overwritten in the cluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.

    • connect_cluster (::Google::Cloud::ManagedKafka::V1::ConnectCluster, ::Hash) (defaults to: nil) —

      Required. The Kafka Connect cluster to update. Its name field must be populated.

    • request_id (::String) (defaults to: nil) —

      Optional. An optional request ID to identify requests. Specify a unique request ID to avoid duplication of requests. If a request times out or fails, retrying with the same ID allows the server to recognize the previous attempt. For at least 60 minutes, the server ignores duplicate requests bearing the same ID.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID within 60 minutes of the last request, the server checks if an original operation with the same request ID was received. If so, the server ignores the second request.

      The request ID must be a valid UUID. A zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/google/cloud/managed_kafka/v1/managed_kafka_connect/client.rb', line 644

def update_connect_cluster request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ManagedKafka::V1::UpdateConnectClusterRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_connect_cluster.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ManagedKafka::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.connect_cluster&.name
    header_params["connect_cluster.name"] = request.connect_cluster.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_connect_cluster.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_connect_cluster.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @managed_kafka_connect_stub.call_rpc :update_connect_cluster, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_connector(request, options = nil) ⇒ ::Google::Cloud::ManagedKafka::V1::Connector #update_connector(update_mask: nil, connector: nil) ⇒ ::Google::Cloud::ManagedKafka::V1::Connector

Updates the properties of a connector.

Examples:

Basic example

require "google/cloud/managed_kafka/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::V1::ManagedKafkaConnect::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::V1::UpdateConnectorRequest.new

# Call the update_connector method.
result = client.update_connector request

# The returned object is of type Google::Cloud::ManagedKafka::V1::Connector.
p result

Overloads:

  • #update_connector(request, options = nil) ⇒ ::Google::Cloud::ManagedKafka::V1::Connector

    Pass arguments to update_connector via a request object, either of type UpdateConnectorRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::ManagedKafka::V1::UpdateConnectorRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_connector(update_mask: nil, connector: nil) ⇒ ::Google::Cloud::ManagedKafka::V1::Connector

    Pass arguments to update_connector via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Required. Field mask is used to specify the fields to be overwritten in the cluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.

    • connector (::Google::Cloud::ManagedKafka::V1::Connector, ::Hash) (defaults to: nil) —

      Required. The connector to update. Its name field must be populated.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
 
# File 'lib/google/cloud/managed_kafka/v1/managed_kafka_connect/client.rb', line 1134

def update_connector request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ManagedKafka::V1::UpdateConnectorRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_connector.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ManagedKafka::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.connector&.name
    header_params["connector.name"] = request.connector.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_connector.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_connector.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @managed_kafka_connect_stub.call_rpc :update_connector, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end