Apache Kafka for BigQuery V1 API - Class Google::Cloud::ManagedKafka::V1::ManagedKafka::Rest::ServiceStub (v0.1.0)

Reference documentation and code samples for the Apache Kafka for BigQuery V1 API class Google::Cloud::ManagedKafka::V1::ManagedKafka::Rest::ServiceStub.

REST service stub for the ManagedKafka service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.

Inherits

• Object

Methods

#create_cluster

def create_cluster(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the create_cluster REST call

Parameters

• request_pb (::Google::Cloud::ManagedKafka::V1::CreateClusterRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#create_topic

def create_topic(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ManagedKafka::V1::Topic

Baseline implementation for the create_topic REST call

Parameters

• request_pb (::Google::Cloud::ManagedKafka::V1::CreateTopicRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::ManagedKafka::V1::Topic)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::ManagedKafka::V1::Topic) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#delete_cluster

def delete_cluster(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the delete_cluster REST call

Parameters

• request_pb (::Google::Cloud::ManagedKafka::V1::DeleteClusterRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#delete_consumer_group

def delete_consumer_group(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_consumer_group REST call

Parameters

• request_pb (::Google::Cloud::ManagedKafka::V1::DeleteConsumerGroupRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Protobuf::Empty)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Protobuf::Empty) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#delete_topic

def delete_topic(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_topic REST call

Parameters

• request_pb (::Google::Cloud::ManagedKafka::V1::DeleteTopicRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Protobuf::Empty)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Protobuf::Empty) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns

• (String)

#get_cluster

def get_cluster(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ManagedKafka::V1::Cluster

Baseline implementation for the get_cluster REST call

Parameters

• request_pb (::Google::Cloud::ManagedKafka::V1::GetClusterRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::ManagedKafka::V1::Cluster)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::ManagedKafka::V1::Cluster) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_consumer_group

def get_consumer_group(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ManagedKafka::V1::ConsumerGroup

Baseline implementation for the get_consumer_group REST call

Parameters

• request_pb (::Google::Cloud::ManagedKafka::V1::GetConsumerGroupRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::ManagedKafka::V1::ConsumerGroup)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::ManagedKafka::V1::ConsumerGroup) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_topic

def get_topic(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ManagedKafka::V1::Topic

Baseline implementation for the get_topic REST call

Parameters

• request_pb (::Google::Cloud::ManagedKafka::V1::GetTopicRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::ManagedKafka::V1::Topic)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::ManagedKafka::V1::Topic) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#initialize

def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub

Returns

• (ServiceStub) — a new instance of ServiceStub

#list_clusters

def list_clusters(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ManagedKafka::V1::ListClustersResponse

Baseline implementation for the list_clusters REST call

Parameters

• request_pb (::Google::Cloud::ManagedKafka::V1::ListClustersRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::ManagedKafka::V1::ListClustersResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::ManagedKafka::V1::ListClustersResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#list_consumer_groups

def list_consumer_groups(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ManagedKafka::V1::ListConsumerGroupsResponse

Baseline implementation for the list_consumer_groups REST call

Parameters

• request_pb (::Google::Cloud::ManagedKafka::V1::ListConsumerGroupsRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::ManagedKafka::V1::ListConsumerGroupsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::ManagedKafka::V1::ListConsumerGroupsResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#list_topics

def list_topics(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ManagedKafka::V1::ListTopicsResponse

Baseline implementation for the list_topics REST call

Parameters

• request_pb (::Google::Cloud::ManagedKafka::V1::ListTopicsRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::ManagedKafka::V1::ListTopicsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::ManagedKafka::V1::ListTopicsResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

• (String)

#update_cluster

def update_cluster(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the update_cluster REST call

Parameters

• request_pb (::Google::Cloud::ManagedKafka::V1::UpdateClusterRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#update_consumer_group

def update_consumer_group(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ManagedKafka::V1::ConsumerGroup

Baseline implementation for the update_consumer_group REST call

Parameters

• request_pb (::Google::Cloud::ManagedKafka::V1::UpdateConsumerGroupRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::ManagedKafka::V1::ConsumerGroup)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::ManagedKafka::V1::ConsumerGroup) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#update_topic

def update_topic(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ManagedKafka::V1::Topic

Baseline implementation for the update_topic REST call

Parameters

• request_pb (::Google::Cloud::ManagedKafka::V1::UpdateTopicRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::ManagedKafka::V1::Topic)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::ManagedKafka::V1::Topic) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)