Class: Google::Apis::ManagedkafkaV1::ManagedKafkaService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/managedkafka_v1/service.rb

Overview

Managed Service for Apache Kafka API

Manage Apache Kafka clusters and resources.

Examples:

require 'google/apis/managedkafka_v1'

Managedkafka = Google::Apis::ManagedkafkaV1 # Alias the module
service = Managedkafka::ManagedKafkaService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE =
"https://managedkafka.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeManagedKafkaService

Returns a new instance of ManagedKafkaService.



47
48
49
50
51
52
# File 'lib/google/apis/managedkafka_v1/service.rb', line 47

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-managedkafka_v1',
        client_version: Google::Apis::ManagedkafkaV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String)

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



40
41
42
# File 'lib/google/apis/managedkafka_v1/service.rb', line 40

def key
  @key
end

#quota_userString

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



45
46
47
# File 'lib/google/apis/managedkafka_v1/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#add_project_location_cluster_acl_acl_entry(acl, acl_entry_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::AddAclEntryResponse

Incremental update: Adds an acl entry to an acl. Creates the acl if it does not exist yet.

Parameters:

  • acl (String)

    Required. The name of the acl to add the acl entry to. Structured like: projects/project/locations/location/clusters/cluster/acls/acl_id`. The structure ofacl_iddefines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. SeeAcl.name` for details.

  • acl_entry_object (Google::Apis::ManagedkafkaV1::AclEntry) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



392
393
394
395
396
397
398
399
400
401
402
# File 'lib/google/apis/managedkafka_v1/service.rb', line 392

def add_project_location_cluster_acl_acl_entry(acl, acl_entry_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+acl}:addAclEntry', options)
  command.request_representation = Google::Apis::ManagedkafkaV1::AclEntry::Representation
  command.request_object = acl_entry_object
  command.response_representation = Google::Apis::ManagedkafkaV1::AddAclEntryResponse::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::AddAclEntryResponse
  command.params['acl'] = acl unless acl.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::Empty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1 , corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • cancel_operation_request_object (Google::Apis::ManagedkafkaV1::CancelOperationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
# File 'lib/google/apis/managedkafka_v1/service.rb', line 1567

def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.request_representation = Google::Apis::ManagedkafkaV1::CancelOperationRequest::Representation
  command.request_object = cancel_operation_request_object
  command.response_representation = Google::Apis::ManagedkafkaV1::Empty::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#check_project_location_schema_registry_compatibility_compatibility(name, check_compatibility_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::CheckCompatibilityResponse

Check compatibility of a schema with all versions or a specific version of a subject.

Parameters:

  • name (String)

    Required. The name of the resource to check compatibility for. The format is either of following: * projects/project/locations/location/ schemaRegistries/schema_registry/compatibility/subjects/*/versions: Check compatibility with one or more versions of the specified subject. * projects/ project/locations/location/schemaRegistries/schema_registry/compatibility/ subjects/subject/versions/version: Check compatibility with a specific version of the subject.

  • check_compatibility_request_object (Google::Apis::ManagedkafkaV1::CheckCompatibilityRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
# File 'lib/google/apis/managedkafka_v1/service.rb', line 1851

def check_project_location_schema_registry_compatibility_compatibility(name, check_compatibility_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ManagedkafkaV1::CheckCompatibilityRequest::Representation
  command.request_object = check_compatibility_request_object
  command.response_representation = Google::Apis::ManagedkafkaV1::CheckCompatibilityResponse::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::CheckCompatibilityResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#check_project_location_schema_registry_context_compatibility_compatibility(name, check_compatibility_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::CheckCompatibilityResponse

Check compatibility of a schema with all versions or a specific version of a subject.

Parameters:

  • name (String)

    Required. The name of the resource to check compatibility for. The format is either of following: * projects/project/locations/location/ schemaRegistries/schema_registry/compatibility/subjects/*/versions: Check compatibility with one or more versions of the specified subject. * projects/ project/locations/location/schemaRegistries/schema_registry/compatibility/ subjects/subject/versions/version: Check compatibility with a specific version of the subject.

  • check_compatibility_request_object (Google::Apis::ManagedkafkaV1::CheckCompatibilityRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
# File 'lib/google/apis/managedkafka_v1/service.rb', line 2062

def check_project_location_schema_registry_context_compatibility_compatibility(name, check_compatibility_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ManagedkafkaV1::CheckCompatibilityRequest::Representation
  command.request_object = check_compatibility_request_object
  command.response_representation = Google::Apis::ManagedkafkaV1::CheckCompatibilityResponse::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::CheckCompatibilityResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_cluster(parent, cluster_object = nil, cluster_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::Operation

Creates a new cluster in a given project and location.

Parameters:

  • parent (String)

    Required. The parent region in which to create the cluster. Structured like projects/project/locations/location``.

  • cluster_object (Google::Apis::ManagedkafkaV1::Cluster) (defaults to: nil)
  • cluster_id (String) (defaults to: nil)

    Required. The ID to use for the 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.

  • 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).

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



178
179
180
181
182
183
184
185
186
187
188
189
190
# File 'lib/google/apis/managedkafka_v1/service.rb', line 178

def create_project_location_cluster(parent, cluster_object = nil, cluster_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/clusters', options)
  command.request_representation = Google::Apis::ManagedkafkaV1::Cluster::Representation
  command.request_object = cluster_object
  command.response_representation = Google::Apis::ManagedkafkaV1::Operation::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['clusterId'] = cluster_id unless cluster_id.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_cluster_acl(parent, acl_object = nil, acl_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::Acl

Creates a new acl in the given project, location, and cluster.

Parameters:

  • parent (String)

    Required. The parent cluster in which to create the acl. Structured like projects/project/locations/location/clusters/cluster``.

  • acl_object (Google::Apis::ManagedkafkaV1::Acl) (defaults to: nil)
  • acl_id (String) (defaults to: nil)

    Required. The ID to use for the acl, which will become the final component of the acl's name. The structure of acl_id defines the Resource Pattern ( resource_type, resource_name, pattern_type) of the acl. acl_id is structured like one of the following: For acls on the cluster: cluster For acls on a single resource within the cluster: topic/resource_name`consumerGroup/` resource_name transactionalId/resource_nameFor acls on all resources that match a prefix: `topicPrefixed/`resource_name consumerGroupPrefixed/ resource_name`transactionalIdPrefixed/`resource_name For acls on all resources of a given type (i.e. the wildcard literal ""): allTopics ( represents `topic/)allConsumerGroups(representsconsumerGroup/) allTransactionalIds(representstransactionalId/`)

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



438
439
440
441
442
443
444
445
446
447
448
449
# File 'lib/google/apis/managedkafka_v1/service.rb', line 438

def create_project_location_cluster_acl(parent, acl_object = nil, acl_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/acls', options)
  command.request_representation = Google::Apis::ManagedkafkaV1::Acl::Representation
  command.request_object = acl_object
  command.response_representation = Google::Apis::ManagedkafkaV1::Acl::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::Acl
  command.params['parent'] = parent unless parent.nil?
  command.query['aclId'] = acl_id unless acl_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_cluster_topic(parent, topic_object = nil, topic_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::Topic

Creates a new topic in a given project and location.

Parameters:

  • parent (String)

    Required. The parent cluster in which to create the topic. Structured like projects/project/locations/location/clusters/cluster``.

  • topic_object (Google::Apis::ManagedkafkaV1::Topic) (defaults to: nil)
  • topic_id (String) (defaults to: nil)

    Required. The ID to use for the topic, which will become the final component of the topic's name. This value is structured like: my-topic-name.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



826
827
828
829
830
831
832
833
834
835
836
837
# File 'lib/google/apis/managedkafka_v1/service.rb', line 826

def create_project_location_cluster_topic(parent, topic_object = nil, topic_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/topics', options)
  command.request_representation = Google::Apis::ManagedkafkaV1::Topic::Representation
  command.request_object = topic_object
  command.response_representation = Google::Apis::ManagedkafkaV1::Topic::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::Topic
  command.params['parent'] = parent unless parent.nil?
  command.query['topicId'] = topic_id unless topic_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_connect_cluster(parent, connect_cluster_object = nil, connect_cluster_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::Operation

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

Parameters:

  • parent (String)

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

  • connect_cluster_object (Google::Apis::ManagedkafkaV1::ConnectCluster) (defaults to: nil)
  • 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

    1. This value is structured like: my-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).

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
# File 'lib/google/apis/managedkafka_v1/service.rb', line 1021

def create_project_location_connect_cluster(parent, connect_cluster_object = nil, connect_cluster_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/connectClusters', options)
  command.request_representation = Google::Apis::ManagedkafkaV1::ConnectCluster::Representation
  command.request_object = connect_cluster_object
  command.response_representation = Google::Apis::ManagedkafkaV1::Operation::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['connectClusterId'] = connect_cluster_id unless connect_cluster_id.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_connect_cluster_connector(parent, connector_object = nil, connector_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::Connector

Creates a new connector in a given Connect cluster.

Parameters:

  • parent (String)

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

  • connector_object (Google::Apis::ManagedkafkaV1::Connector) (defaults to: nil)
  • 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

    1. This value is structured like: my-connector-id.
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
# File 'lib/google/apis/managedkafka_v1/service.rb', line 1239

def create_project_location_connect_cluster_connector(parent, connector_object = nil, connector_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/connectors', options)
  command.request_representation = Google::Apis::ManagedkafkaV1::Connector::Representation
  command.request_object = connector_object
  command.response_representation = Google::Apis::ManagedkafkaV1::Connector::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::Connector
  command.params['parent'] = parent unless parent.nil?
  command.query['connectorId'] = connector_id unless connector_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_schema_registry_context_subject_version(parent, create_version_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::CreateVersionResponse

Register a new version under a given subject with the given schema.

Parameters:

  • parent (String)

    Required. The subject to create the version for. Structured like: projects/ project/locations/location/schemaRegistries/schema_registry/subjects/ subjector `projects/`project`/locations/`location`/schemaRegistries/` schema_registry`/contexts/`context`/subjects/`subject

  • create_version_request_object (Google::Apis::ManagedkafkaV1::CreateVersionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
# File 'lib/google/apis/managedkafka_v1/service.rb', line 2622

def create_project_location_schema_registry_context_subject_version(parent, create_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/versions', options)
  command.request_representation = Google::Apis::ManagedkafkaV1::CreateVersionRequest::Representation
  command.request_object = create_version_request_object
  command.response_representation = Google::Apis::ManagedkafkaV1::CreateVersionResponse::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::CreateVersionResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_schema_registry_subject_version(parent, create_version_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::CreateVersionResponse

Register a new version under a given subject with the given schema.

Parameters:

  • parent (String)

    Required. The subject to create the version for. Structured like: projects/ project/locations/location/schemaRegistries/schema_registry/subjects/ subjector `projects/`project`/locations/`location`/schemaRegistries/` schema_registry`/contexts/`context`/subjects/`subject

  • create_version_request_object (Google::Apis::ManagedkafkaV1::CreateVersionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
# File 'lib/google/apis/managedkafka_v1/service.rb', line 3267

def create_project_location_schema_registry_subject_version(parent, create_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/versions', options)
  command.request_representation = Google::Apis::ManagedkafkaV1::CreateVersionRequest::Representation
  command.request_object = create_version_request_object
  command.response_representation = Google::Apis::ManagedkafkaV1::CreateVersionResponse::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::CreateVersionResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_schema_registry(parent, create_schema_registry_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::SchemaRegistry

Create a schema registry instance.

Parameters:

  • parent (String)

    Required. The parent whose schema registry instance is to be created. Structured like: projects/project/locations/location``

  • create_schema_registry_request_object (Google::Apis::ManagedkafkaV1::CreateSchemaRegistryRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
# File 'lib/google/apis/managedkafka_v1/service.rb', line 1714

def create_schema_registry(parent, create_schema_registry_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/schemaRegistries', options)
  command.request_representation = Google::Apis::ManagedkafkaV1::CreateSchemaRegistryRequest::Representation
  command.request_object = create_schema_registry_request_object
  command.response_representation = Google::Apis::ManagedkafkaV1::SchemaRegistry::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::SchemaRegistry
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_cluster(name, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::Operation

Deletes a single cluster.

Parameters:

  • name (String)

    Required. The name of the cluster to delete.

  • 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).

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



223
224
225
226
227
228
229
230
231
232
# File 'lib/google/apis/managedkafka_v1/service.rb', line 223

def delete_project_location_cluster(name, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::Operation::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_cluster_acl(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::Empty

Deletes an acl.

Parameters:

  • name (String)

    Required. The name of the acl to delete. Structured like: projects/project/ locations/location/clusters/cluster/acls/acl_id`. The structure of acl_iddefines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. SeeAcl.name` for details.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



474
475
476
477
478
479
480
481
482
# File 'lib/google/apis/managedkafka_v1/service.rb', line 474

def delete_project_location_cluster_acl(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::Empty::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_cluster_consumer_group(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::Empty

Deletes a single consumer group.

Parameters:

  • name (String)

    Required. The name of the consumer group to delete. projects/project/ locations/location/clusters/cluster/consumerGroups/consumerGroup``.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



666
667
668
669
670
671
672
673
674
# File 'lib/google/apis/managedkafka_v1/service.rb', line 666

def delete_project_location_cluster_consumer_group(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::Empty::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_cluster_topic(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::Empty

Deletes a single topic.

Parameters:

  • name (String)

    Required. The name of the topic to delete. projects/project/locations/ location/clusters/cluster/topics/topic``.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



860
861
862
863
864
865
866
867
868
# File 'lib/google/apis/managedkafka_v1/service.rb', line 860

def delete_project_location_cluster_topic(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::Empty::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_connect_cluster(name, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::Operation

Deletes a single Connect cluster.

Parameters:

  • name (String)

    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).

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
# File 'lib/google/apis/managedkafka_v1/service.rb', line 1067

def delete_project_location_connect_cluster(name, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::Operation::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_connect_cluster_connector(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::Empty

Deletes a connector.

Parameters:

  • name (String)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1274
1275
1276
1277
1278
1279
1280
1281
1282
# File 'lib/google/apis/managedkafka_v1/service.rb', line 1274

def delete_project_location_connect_cluster_connector(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::Empty::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::Empty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1602
1603
1604
1605
1606
1607
1608
1609
1610
# File 'lib/google/apis/managedkafka_v1/service.rb', line 1602

def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::Empty::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_schema_registry(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::Empty

Delete a schema registry instance.

Parameters:

  • name (String)

    Required. The name of the schema registry instance to delete. Structured like: projects/project/locations/location/schemaRegistries/schema_registry``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1747
1748
1749
1750
1751
1752
1753
1754
1755
# File 'lib/google/apis/managedkafka_v1/service.rb', line 1747

def delete_project_location_schema_registry(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::Empty::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_schema_registry_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::SchemaConfig

Delete schema config for a subject.

Parameters:

  • name (String)

    Required. The resource name of subject to delete the config for. The format is

    • projects/project/locations/location/schemaRegistries/schema_registry/ config/subject
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1885
1886
1887
1888
1889
1890
1891
1892
1893
# File 'lib/google/apis/managedkafka_v1/service.rb', line 1885

def delete_project_location_schema_registry_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::SchemaConfig::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::SchemaConfig
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_schema_registry_context_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::SchemaConfig

Delete schema config for a subject.

Parameters:

  • name (String)

    Required. The resource name of subject to delete the config for. The format is

    • projects/project/locations/location/schemaRegistries/schema_registry/ config/subject
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2096
2097
2098
2099
2100
2101
2102
2103
2104
# File 'lib/google/apis/managedkafka_v1/service.rb', line 2096

def delete_project_location_schema_registry_context_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::SchemaConfig::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::SchemaConfig
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_schema_registry_context_mode(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::SchemaMode

Delete schema mode for a subject.

Parameters:

  • name (String)

    Required. The resource name of subject to delete the mode for. The format is * projects/project/locations/location/schemaRegistries/schema_registry/ mode/subject * projects/project/locations/location/schemaRegistries/ schema_registry/contexts/context/mode/subject

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2205
2206
2207
2208
2209
2210
2211
2212
2213
# File 'lib/google/apis/managedkafka_v1/service.rb', line 2205

def delete_project_location_schema_registry_context_mode(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::SchemaMode::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::SchemaMode
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_schema_registry_context_subject(name, permanent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::HttpBody

Delete a subject. The response will be an array of versions of the deleted subject.

Parameters:

  • name (String)

    Required. The name of the subject to delete. Structured like: projects/ project/locations/location/schemaRegistries/schema_registry/subjects/ subjector `projects/`project`/locations/`location`/schemaRegistries/` schema_registry`/contexts/`context`/subjects/`subject

  • permanent (Boolean) (defaults to: nil)

    Optional. If true, the subject and all associated metadata including the schema ID will be deleted permanently. Otherwise, only the subject is soft- deleted. The default is false. Soft-deleted subjects can still be searched in ListSubjects API call with deleted=true query parameter. A soft-delete of a subject must be performed before a hard-delete.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
# File 'lib/google/apis/managedkafka_v1/service.rb', line 2507

def delete_project_location_schema_registry_context_subject(name, permanent: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::HttpBody::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::HttpBody
  command.params['name'] = name unless name.nil?
  command.query['permanent'] = permanent unless permanent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_schema_registry_context_subject_version(name, permanent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::HttpBody

Delete a version of a subject. The response will be the deleted version id.

Parameters:

  • name (String)

    Required. The name of the subject version to delete. Structured like: projects/project/locations/location/schemaRegistries/schema_registry/ subjects/subject/versions/versionor `projects/`project`/locations/` location`/schemaRegistries/`schema_registry`/contexts/`context`/subjects/` subject`/versions/`version

  • permanent (Boolean) (defaults to: nil)

    Optional. If true, both the version and the referenced schema ID will be permanently deleted. The default is false. If false, the version will be deleted but the schema ID will be retained. Soft-deleted versions can still be searched in ListVersions API call with deleted=true query parameter. A soft- delete of a version must be performed before a hard-delete.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
# File 'lib/google/apis/managedkafka_v1/service.rb', line 2664

def delete_project_location_schema_registry_context_subject_version(name, permanent: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::HttpBody::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::HttpBody
  command.params['name'] = name unless name.nil?
  command.query['permanent'] = permanent unless permanent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_schema_registry_mode(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::SchemaMode

Delete schema mode for a subject.

Parameters:

  • name (String)

    Required. The resource name of subject to delete the mode for. The format is * projects/project/locations/location/schemaRegistries/schema_registry/ mode/subject * projects/project/locations/location/schemaRegistries/ schema_registry/contexts/context/mode/subject

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2850
2851
2852
2853
2854
2855
2856
2857
2858
# File 'lib/google/apis/managedkafka_v1/service.rb', line 2850

def delete_project_location_schema_registry_mode(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::SchemaMode::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::SchemaMode
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_schema_registry_subject(name, permanent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::HttpBody

Delete a subject. The response will be an array of versions of the deleted subject.

Parameters:

  • name (String)

    Required. The name of the subject to delete. Structured like: projects/ project/locations/location/schemaRegistries/schema_registry/subjects/ subjector `projects/`project`/locations/`location`/schemaRegistries/` schema_registry`/contexts/`context`/subjects/`subject

  • permanent (Boolean) (defaults to: nil)

    Optional. If true, the subject and all associated metadata including the schema ID will be deleted permanently. Otherwise, only the subject is soft- deleted. The default is false. Soft-deleted subjects can still be searched in ListSubjects API call with deleted=true query parameter. A soft-delete of a subject must be performed before a hard-delete.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
# File 'lib/google/apis/managedkafka_v1/service.rb', line 3152

def delete_project_location_schema_registry_subject(name, permanent: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::HttpBody::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::HttpBody
  command.params['name'] = name unless name.nil?
  command.query['permanent'] = permanent unless permanent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_schema_registry_subject_version(name, permanent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::HttpBody

Delete a version of a subject. The response will be the deleted version id.

Parameters:

  • name (String)

    Required. The name of the subject version to delete. Structured like: projects/project/locations/location/schemaRegistries/schema_registry/ subjects/subject/versions/versionor `projects/`project`/locations/` location`/schemaRegistries/`schema_registry`/contexts/`context`/subjects/` subject`/versions/`version

  • permanent (Boolean) (defaults to: nil)

    Optional. If true, both the version and the referenced schema ID will be permanently deleted. The default is false. If false, the version will be deleted but the schema ID will be retained. Soft-deleted versions can still be searched in ListVersions API call with deleted=true query parameter. A soft- delete of a version must be performed before a hard-delete.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
# File 'lib/google/apis/managedkafka_v1/service.rb', line 3309

def delete_project_location_schema_registry_subject_version(name, permanent: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::HttpBody::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::HttpBody
  command.params['name'] = name unless name.nil?
  command.query['permanent'] = permanent unless permanent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::Location

Gets information about a location.

Parameters:

  • name (String)

    Resource name for the location.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



74
75
76
77
78
79
80
81
82
# File 'lib/google/apis/managedkafka_v1/service.rb', line 74

def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::Location::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::Location
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_cluster(name, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::Cluster

Returns the properties of a single cluster.

Parameters:

  • name (String)

    Required. The name of the cluster whose configuration to return.

  • view (String) (defaults to: nil)

    Optional. Specifies the view of the Cluster resource to be returned. Defaults to CLUSTER_VIEW_BASIC. See the ClusterView enum for possible values.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



257
258
259
260
261
262
263
264
265
266
# File 'lib/google/apis/managedkafka_v1/service.rb', line 257

def get_project_location_cluster(name, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::Cluster::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::Cluster
  command.params['name'] = name unless name.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_cluster_acl(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::Acl

Returns the properties of a single acl.

Parameters:

  • name (String)

    Required. The name of the acl to return. Structured like: projects/project/ locations/location/clusters/cluster/acls/acl_id`. The structure of acl_iddefines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. SeeAcl.name` for details.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



507
508
509
510
511
512
513
514
515
# File 'lib/google/apis/managedkafka_v1/service.rb', line 507

def get_project_location_cluster_acl(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::Acl::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::Acl
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_cluster_consumer_group(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::ConsumerGroup

Returns the properties of a single consumer group.

Parameters:

  • name (String)

    Required. The name of the consumer group whose configuration to return. projects/project/locations/location/clusters/cluster/consumerGroups/ consumerGroup``.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



698
699
700
701
702
703
704
705
706
# File 'lib/google/apis/managedkafka_v1/service.rb', line 698

def get_project_location_cluster_consumer_group(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::ConsumerGroup::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::ConsumerGroup
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_cluster_topic(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::Topic

Returns the properties of a single topic.

Parameters:

  • name (String)

    Required. The name of the topic whose configuration to return. Structured like: projects/project/locations/location/clusters/cluster/topics/topic.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



891
892
893
894
895
896
897
898
899
# File 'lib/google/apis/managedkafka_v1/service.rb', line 891

def get_project_location_cluster_topic(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::Topic::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::Topic
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_connect_cluster(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::ConnectCluster

Returns the properties of a single Kafka Connect cluster.

Parameters:

  • name (String)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1100
1101
1102
1103
1104
1105
1106
1107
1108
# File 'lib/google/apis/managedkafka_v1/service.rb', line 1100

def get_project_location_connect_cluster(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::ConnectCluster::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::ConnectCluster
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_connect_cluster_connector(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::Connector

Returns the properties of a single connector.

Parameters:

  • name (String)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1306
1307
1308
1309
1310
1311
1312
1313
1314
# File 'lib/google/apis/managedkafka_v1/service.rb', line 1306

def get_project_location_connect_cluster_connector(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::Connector::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::Connector
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::Operation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1633
1634
1635
1636
1637
1638
1639
1640
1641
# File 'lib/google/apis/managedkafka_v1/service.rb', line 1633

def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::Operation::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_schema_registry(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::SchemaRegistry

Get the schema registry instance.

Parameters:

  • name (String)

    Required. The name of the schema registry instance to return. Structured like: projects/project/locations/location/schemaRegistries/schema_registry``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1778
1779
1780
1781
1782
1783
1784
1785
1786
# File 'lib/google/apis/managedkafka_v1/service.rb', line 1778

def get_project_location_schema_registry(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::SchemaRegistry::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::SchemaRegistry
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_schema_registry_config(name, default_to_global: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::SchemaConfig

Get schema config at global level or for a subject.

Parameters:

  • name (String)

    Required. The resource name to get the config for. It can be either of following: * projects/project/locations/location/schemaRegistries/ schema_registry/config: Get config at global level. * projects/project/ locations/location/schemaRegistries/schema_registry/config/subject: Get config for a specific subject.

  • default_to_global (Boolean) (defaults to: nil)

    Optional. If true, the config will fall back to the config at the global level if no subject level config is found.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
# File 'lib/google/apis/managedkafka_v1/service.rb', line 1922

def get_project_location_schema_registry_config(name, default_to_global: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::SchemaConfig::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::SchemaConfig
  command.params['name'] = name unless name.nil?
  command.query['defaultToGlobal'] = default_to_global unless default_to_global.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_schema_registry_context(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::Context

Get the context.

Parameters:

  • name (String)

    Required. The name of the context to return. Structured like: projects/ project/locations/location/schemaRegistries/schema_registry/contexts/ context``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1993
1994
1995
1996
1997
1998
1999
2000
2001
# File 'lib/google/apis/managedkafka_v1/service.rb', line 1993

def get_project_location_schema_registry_context(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::Context::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::Context
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_schema_registry_context_config(name, default_to_global: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::SchemaConfig

Get schema config at global level or for a subject.

Parameters:

  • name (String)

    Required. The resource name to get the config for. It can be either of following: * projects/project/locations/location/schemaRegistries/ schema_registry/config: Get config at global level. * projects/project/ locations/location/schemaRegistries/schema_registry/config/subject: Get config for a specific subject.

  • default_to_global (Boolean) (defaults to: nil)

    Optional. If true, the config will fall back to the config at the global level if no subject level config is found.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
# File 'lib/google/apis/managedkafka_v1/service.rb', line 2133

def get_project_location_schema_registry_context_config(name, default_to_global: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::SchemaConfig::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::SchemaConfig
  command.params['name'] = name unless name.nil?
  command.query['defaultToGlobal'] = default_to_global unless default_to_global.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_schema_registry_context_mode(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::SchemaMode

Get mode at global level or for a subject.

Parameters:

  • name (String)

    Required. The resource name of the mode. The format is * projects/project/ locations/location/schemaRegistries/schema_registry/mode/subject: mode for a schema registry, or * projects/project/locations/location/ schemaRegistries/schema_registry/contexts/context/mode/subject: mode for a specific subject in a specific context

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2239
2240
2241
2242
2243
2244
2245
2246
2247
# File 'lib/google/apis/managedkafka_v1/service.rb', line 2239

def get_project_location_schema_registry_context_mode(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::SchemaMode::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::SchemaMode
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_schema_registry_context_schema(name, subject: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::Schema

Get the schema for the given schema id.

Parameters:

  • name (String)

    Required. The name of the schema to return. Structured like: projects/ project/locations/location/schemaRegistries/schema_registry/schemas/ids/ schema``

  • subject (String) (defaults to: nil)

    Optional. Used to limit the search for the schema ID to a specific subject, otherwise the schema ID will be searched for in all subjects in the given specified context.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
# File 'lib/google/apis/managedkafka_v1/service.rb', line 2312

def get_project_location_schema_registry_context_schema(name, subject: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::Schema::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::Schema
  command.params['name'] = name unless name.nil?
  command.query['subject'] = subject unless subject.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_schema_registry_context_schema_schema(name, subject: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::HttpBody

Get the schema string for the given schema id. The response will be the schema string.

Parameters:

  • name (String)

    Required. The name of the schema to return. Structured like: projects/ project/locations/location/schemaRegistries/schema_registry/schemas/ids/ schema``

  • subject (String) (defaults to: nil)

    Optional. Used to limit the search for the schema ID to a specific subject, otherwise the schema ID will be searched for in all subjects in the given specified context.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
# File 'lib/google/apis/managedkafka_v1/service.rb', line 2350

def get_project_location_schema_registry_context_schema_schema(name, subject: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/schema', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::HttpBody::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::HttpBody
  command.params['name'] = name unless name.nil?
  command.query['subject'] = subject unless subject.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_schema_registry_context_subject_version(name, deleted: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::SchemaVersion

Get a versioned schema (schema with subject/version) of a subject.

Parameters:

  • name (String)

    Required. The name of the subject to return versions. Structured like: projects/project/locations/location/schemaRegistries/schema_registry/ subjects/subject/versions/versionor `projects/`project`/locations/` location`/schemaRegistries/`schema_registry`/contexts/`context`/subjects/` subject`/versions/`version

  • deleted (Boolean) (defaults to: nil)

    Optional. If true, no matter if the subject/version is soft-deleted or not, it returns the version details. If false, it returns NOT_FOUND error if the subject/version is soft-deleted. The default is false.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
# File 'lib/google/apis/managedkafka_v1/service.rb', line 2703

def get_project_location_schema_registry_context_subject_version(name, deleted: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::SchemaVersion::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::SchemaVersion
  command.params['name'] = name unless name.nil?
  command.query['deleted'] = deleted unless deleted.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_schema_registry_context_subject_version_schema(name, deleted: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::HttpBody

Get the schema string only for a version of a subject. The response will be the schema string.

Parameters:

  • name (String)

    Required. The name of the subject to return versions. Structured like: projects/project/locations/location/schemaRegistries/schema_registry/ subjects/subject/versions/versionor `projects/`project`/locations/` location`/schemaRegistries/`schema_registry`/contexts/`context`/subjects/` subject`/versions/`version

  • deleted (Boolean) (defaults to: nil)

    Optional. If true, no matter if the subject/version is soft-deleted or not, it returns the version details. If false, it returns NOT_FOUND error if the subject/version is soft-deleted. The default is false.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
# File 'lib/google/apis/managedkafka_v1/service.rb', line 2743

def get_project_location_schema_registry_context_subject_version_schema(name, deleted: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/schema', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::HttpBody::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::HttpBody
  command.params['name'] = name unless name.nil?
  command.query['deleted'] = deleted unless deleted.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_schema_registry_mode(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::SchemaMode

Get mode at global level or for a subject.

Parameters:

  • name (String)

    Required. The resource name of the mode. The format is * projects/project/ locations/location/schemaRegistries/schema_registry/mode/subject: mode for a schema registry, or * projects/project/locations/location/ schemaRegistries/schema_registry/contexts/context/mode/subject: mode for a specific subject in a specific context

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2884
2885
2886
2887
2888
2889
2890
2891
2892
# File 'lib/google/apis/managedkafka_v1/service.rb', line 2884

def get_project_location_schema_registry_mode(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::SchemaMode::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::SchemaMode
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_schema_registry_schema(name, subject: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::Schema

Get the schema for the given schema id.

Parameters:

  • name (String)

    Required. The name of the schema to return. Structured like: projects/ project/locations/location/schemaRegistries/schema_registry/schemas/ids/ schema``

  • subject (String) (defaults to: nil)

    Optional. Used to limit the search for the schema ID to a specific subject, otherwise the schema ID will be searched for in all subjects in the given specified context.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
# File 'lib/google/apis/managedkafka_v1/service.rb', line 2957

def get_project_location_schema_registry_schema(name, subject: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::Schema::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::Schema
  command.params['name'] = name unless name.nil?
  command.query['subject'] = subject unless subject.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_schema_registry_schema_schema(name, subject: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::HttpBody

Get the schema string for the given schema id. The response will be the schema string.

Parameters:

  • name (String)

    Required. The name of the schema to return. Structured like: projects/ project/locations/location/schemaRegistries/schema_registry/schemas/ids/ schema``

  • subject (String) (defaults to: nil)

    Optional. Used to limit the search for the schema ID to a specific subject, otherwise the schema ID will be searched for in all subjects in the given specified context.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
# File 'lib/google/apis/managedkafka_v1/service.rb', line 2995

def get_project_location_schema_registry_schema_schema(name, subject: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/schema', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::HttpBody::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::HttpBody
  command.params['name'] = name unless name.nil?
  command.query['subject'] = subject unless subject.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_schema_registry_subject_version(name, deleted: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::SchemaVersion

Get a versioned schema (schema with subject/version) of a subject.

Parameters:

  • name (String)

    Required. The name of the subject to return versions. Structured like: projects/project/locations/location/schemaRegistries/schema_registry/ subjects/subject/versions/versionor `projects/`project`/locations/` location`/schemaRegistries/`schema_registry`/contexts/`context`/subjects/` subject`/versions/`version

  • deleted (Boolean) (defaults to: nil)

    Optional. If true, no matter if the subject/version is soft-deleted or not, it returns the version details. If false, it returns NOT_FOUND error if the subject/version is soft-deleted. The default is false.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
# File 'lib/google/apis/managedkafka_v1/service.rb', line 3348

def get_project_location_schema_registry_subject_version(name, deleted: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::SchemaVersion::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::SchemaVersion
  command.params['name'] = name unless name.nil?
  command.query['deleted'] = deleted unless deleted.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_schema_registry_subject_version_schema(name, deleted: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::HttpBody

Get the schema string only for a version of a subject. The response will be the schema string.

Parameters:

  • name (String)

    Required. The name of the subject to return versions. Structured like: projects/project/locations/location/schemaRegistries/schema_registry/ subjects/subject/versions/versionor `projects/`project`/locations/` location`/schemaRegistries/`schema_registry`/contexts/`context`/subjects/` subject`/versions/`version

  • deleted (Boolean) (defaults to: nil)

    Optional. If true, no matter if the subject/version is soft-deleted or not, it returns the version details. If false, it returns NOT_FOUND error if the subject/version is soft-deleted. The default is false.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
# File 'lib/google/apis/managedkafka_v1/service.rb', line 3388

def get_project_location_schema_registry_subject_version_schema(name, deleted: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/schema', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::HttpBody::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::HttpBody
  command.params['name'] = name unless name.nil?
  command.query['deleted'] = deleted unless deleted.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_cluster_acls(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::ListAclsResponse

Lists the acls in a given cluster.

Parameters:

  • parent (String)

    Required. The parent cluster whose acls are to be listed. Structured like projects/project/locations/location/clusters/cluster``.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of acls to return. The service may return fewer than this value. If unset or zero, all acls for the parent is returned.

  • page_token (String) (defaults to: nil)

    Optional. A page token, received from a previous ListAcls call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAcls must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



545
546
547
548
549
550
551
552
553
554
555
# File 'lib/google/apis/managedkafka_v1/service.rb', line 545

def list_project_location_cluster_acls(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/acls', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::ListAclsResponse::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::ListAclsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_cluster_consumer_groups(parent, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::ListConsumerGroupsResponse

Lists the consumer groups in a given cluster.

Parameters:

  • parent (String)

    Required. The parent cluster whose consumer groups are to be listed. Structured like projects/project/locations/location/clusters/cluster``.

  • filter (String) (defaults to: nil)

    Optional. Filter expression for the result. Only supports filtering by topic name as a key in the topics map.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of consumer groups to return. The service may return fewer than this value. If unset or zero, all consumer groups for the parent is returned.

  • page_token (String) (defaults to: nil)

    Optional. A page token, received from a previous ListConsumerGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListConsumerGroups must match the call that provided the page token.

  • view (String) (defaults to: nil)

    Optional. Specifies the view (BASIC or FULL) of the ConsumerGroup resource to be returned in the response. Defaults to FULL view.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



744
745
746
747
748
749
750
751
752
753
754
755
756
# File 'lib/google/apis/managedkafka_v1/service.rb', line 744

def list_project_location_cluster_consumer_groups(parent, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/consumerGroups', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::ListConsumerGroupsResponse::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::ListConsumerGroupsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_cluster_topics(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::ListTopicsResponse

Lists the topics in a given cluster.

Parameters:

  • parent (String)

    Required. The parent cluster whose topics are to be listed. Structured like projects/project/locations/location/clusters/cluster``.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of topics to return. The service may return fewer than this value. If unset or zero, all topics for the parent is returned.

  • page_token (String) (defaults to: nil)

    Optional. A page token, received from a previous ListTopics call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListTopics must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



929
930
931
932
933
934
935
936
937
938
939
# File 'lib/google/apis/managedkafka_v1/service.rb', line 929

def list_project_location_cluster_topics(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/topics', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::ListTopicsResponse::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::ListTopicsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_clusters(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::ListClustersResponse

Lists the clusters in a given project and location.

Parameters:

  • parent (String)

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

  • filter (String) (defaults to: nil)

    Optional. Filter expression for the result.

  • order_by (String) (defaults to: nil)

    Optional. Order by fields for the result.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of 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 ListClusters call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListClusters must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



300
301
302
303
304
305
306
307
308
309
310
311
312
# File 'lib/google/apis/managedkafka_v1/service.rb', line 300

def list_project_location_clusters(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/clusters', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::ListClustersResponse::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::ListClustersResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_connect_cluster_connectors(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::ListConnectorsResponse

Lists the connectors in a given Connect cluster.

Parameters:

  • parent (String)

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

  • page_size (Fixnum) (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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
# File 'lib/google/apis/managedkafka_v1/service.rb', line 1346

def list_project_location_connect_cluster_connectors(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/connectors', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::ListConnectorsResponse::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::ListConnectorsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_connect_clusters(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::ListConnectClustersResponse

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

Parameters:

  • parent (String)

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

  • filter (String) (defaults to: nil)

    Optional. Filter expression for the result.

  • order_by (String) (defaults to: nil)

    Optional. Order by fields for the result.

  • page_size (Fixnum) (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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
# File 'lib/google/apis/managedkafka_v1/service.rb', line 1144

def list_project_location_connect_clusters(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/connectClusters', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::ListConnectClustersResponse::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::ListConnectClustersResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::ListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • return_partial_success (Boolean) (defaults to: nil)

    When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse. unreachable field. This can only be true when reading across collections. For example, when parent is set to "projects/example/locations/-". This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
# File 'lib/google/apis/managedkafka_v1/service.rb', line 1678

def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::ListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_schema_registries(parent, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::ListSchemaRegistriesResponse

List schema registries.

Parameters:

  • parent (String)

    Required. The parent whose schema registry instances are to be listed. Structured like: projects/project/locations/location``

  • view (String) (defaults to: nil)

    Optional. Specifies the view to return for the schema registry instances. If not specified, the default view is SCHEMA_REGISTRY_VIEW_BASIC.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
# File 'lib/google/apis/managedkafka_v1/service.rb', line 1812

def list_project_location_schema_registries(parent, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/schemaRegistries', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::ListSchemaRegistriesResponse::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::ListSchemaRegistriesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_schema_registry_context_schema_subjects(parent, deleted: nil, subject: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::HttpBody

List subjects which reference a particular schema id. The response will be an array of subject names.

Parameters:

  • parent (String)

    Required. The schema resource whose associated subjects are to be listed. Structured like: projects/project/locations/location/schemaRegistries/ schema_registry/schemas/ids/schemaor `projects/`project`/locations/` location`/schemaRegistries/`schema_registry`/contexts/`context`/schemas/ids/` schema

  • deleted (Boolean) (defaults to: nil)

    Optional. If true, the response will include soft-deleted subjects. The default is false.

  • subject (String) (defaults to: nil)

    Optional. The subject to filter the subjects by.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
# File 'lib/google/apis/managedkafka_v1/service.rb', line 2391

def list_project_location_schema_registry_context_schema_subjects(parent, deleted: nil, subject: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/subjects', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::HttpBody::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.query['deleted'] = deleted unless deleted.nil?
  command.query['subject'] = subject unless subject.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_schema_registry_context_schema_types(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::HttpBody

List the supported schema types. The response will be an array of schema types.

Parameters:

  • parent (String)

    Required. The parent schema registry whose schema types are to be listed. Structured like: projects/project/locations/location/schemaRegistries/ schema_registry``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2425
2426
2427
2428
2429
2430
2431
2432
2433
# File 'lib/google/apis/managedkafka_v1/service.rb', line 2425

def list_project_location_schema_registry_context_schema_types(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/schemas/types', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::HttpBody::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_schema_registry_context_schema_versions(parent, deleted: nil, subject: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::HttpBody

List the schema versions for the given schema id. The response will be an array of subject-version pairs as: ["subject":"subject1", "version":1, " subject":"subject2", "version":2].

Parameters:

  • parent (String)

    Required. The schema whose schema versions are to be listed. Structured like: projects/project/locations/location/schemaRegistries/schema_registry/ schemas/ids/schemaor `projects/`project`/locations/`location`/ schemaRegistries/`schema_registry`/contexts/`context`/schemas/ids/`schema

  • deleted (Boolean) (defaults to: nil)

    Optional. If true, the response will include soft-deleted versions of the schema, even if the subject is soft-deleted. The default is false.

  • subject (String) (defaults to: nil)

    Optional. The subject to filter the subjects by.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
# File 'lib/google/apis/managedkafka_v1/service.rb', line 2465

def list_project_location_schema_registry_context_schema_versions(parent, deleted: nil, subject: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/versions', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::HttpBody::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.query['deleted'] = deleted unless deleted.nil?
  command.query['subject'] = subject unless subject.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_schema_registry_context_subject_version_referencedbies(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::HttpBody

Get a list of IDs of schemas that reference the schema with the given subject and version.

Parameters:

  • parent (String)

    Required. The version to list referenced by. Structured like: projects/ project/locations/location/schemaRegistries/schema_registry/subjects/ subject/versions/versionor `projects/`project`/locations/`location`/ schemaRegistries/`schema_registry`/contexts/`context`/subjects/`subject`/ versions/`version

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2817
2818
2819
2820
2821
2822
2823
2824
2825
# File 'lib/google/apis/managedkafka_v1/service.rb', line 2817

def list_project_location_schema_registry_context_subject_version_referencedbies(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/referencedby', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::HttpBody::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_schema_registry_context_subject_versions(parent, deleted: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::HttpBody

Get all versions of a subject. The response will be an array of versions of the subject.

Parameters:

  • parent (String)

    Required. The subject whose versions are to be listed. Structured like: projects/project/locations/location/schemaRegistries/schema_registry/ subjects/subjector `projects/`project`/locations/`location`/ schemaRegistries/`schema_registry`/contexts/`context`/subjects/`subject

  • deleted (Boolean) (defaults to: nil)

    Optional. If true, the response will include soft-deleted versions of an active or soft-deleted subject. The default is false.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
# File 'lib/google/apis/managedkafka_v1/service.rb', line 2781

def list_project_location_schema_registry_context_subject_versions(parent, deleted: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/versions', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::HttpBody::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.query['deleted'] = deleted unless deleted.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_schema_registry_context_subjects(parent, deleted: nil, subject_prefix: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::HttpBody

List subjects in the schema registry. The response will be an array of subject names.

Parameters:

  • parent (String)

    Required. The parent schema registry/context whose subjects are to be listed. Structured like: projects/project/locations/location/schemaRegistries/ schema_registryor `projects/`project`/locations/`location`/schemaRegistries/ `schema_registry`/contexts/`context

  • deleted (Boolean) (defaults to: nil)

    Optional. If true, the response will include soft-deleted subjects. The default is false.

  • subject_prefix (String) (defaults to: nil)

    Optional. The context to filter the subjects by, in the format of :.context: . If unset, all subjects in the registry are returned. Set to empty string or add as '?subjectPrefix=' at the end of this request to list subjects in the default context.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
# File 'lib/google/apis/managedkafka_v1/service.rb', line 2550

def list_project_location_schema_registry_context_subjects(parent, deleted: nil, subject_prefix: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/subjects', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::HttpBody::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.query['deleted'] = deleted unless deleted.nil?
  command.query['subjectPrefix'] = subject_prefix unless subject_prefix.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_schema_registry_contexts(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::HttpBody

List contexts for a schema registry.

Parameters:

  • parent (String)

    Required. The parent of the contexts. Structured like: projects/project/ locations/location/schemaRegistries/schema_registry``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2024
2025
2026
2027
2028
2029
2030
2031
2032
# File 'lib/google/apis/managedkafka_v1/service.rb', line 2024

def list_project_location_schema_registry_contexts(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/contexts', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::HttpBody::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_schema_registry_schema_subjects(parent, deleted: nil, subject: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::HttpBody

List subjects which reference a particular schema id. The response will be an array of subject names.

Parameters:

  • parent (String)

    Required. The schema resource whose associated subjects are to be listed. Structured like: projects/project/locations/location/schemaRegistries/ schema_registry/schemas/ids/schemaor `projects/`project`/locations/` location`/schemaRegistries/`schema_registry`/contexts/`context`/schemas/ids/` schema

  • deleted (Boolean) (defaults to: nil)

    Optional. If true, the response will include soft-deleted subjects. The default is false.

  • subject (String) (defaults to: nil)

    Optional. The subject to filter the subjects by.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
# File 'lib/google/apis/managedkafka_v1/service.rb', line 3036

def list_project_location_schema_registry_schema_subjects(parent, deleted: nil, subject: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/subjects', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::HttpBody::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.query['deleted'] = deleted unless deleted.nil?
  command.query['subject'] = subject unless subject.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_schema_registry_schema_types(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::HttpBody

List the supported schema types. The response will be an array of schema types.

Parameters:

  • parent (String)

    Required. The parent schema registry whose schema types are to be listed. Structured like: projects/project/locations/location/schemaRegistries/ schema_registry``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3070
3071
3072
3073
3074
3075
3076
3077
3078
# File 'lib/google/apis/managedkafka_v1/service.rb', line 3070

def list_project_location_schema_registry_schema_types(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/schemas/types', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::HttpBody::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_schema_registry_schema_versions(parent, deleted: nil, subject: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::HttpBody

List the schema versions for the given schema id. The response will be an array of subject-version pairs as: ["subject":"subject1", "version":1, " subject":"subject2", "version":2].

Parameters:

  • parent (String)

    Required. The schema whose schema versions are to be listed. Structured like: projects/project/locations/location/schemaRegistries/schema_registry/ schemas/ids/schemaor `projects/`project`/locations/`location`/ schemaRegistries/`schema_registry`/contexts/`context`/schemas/ids/`schema

  • deleted (Boolean) (defaults to: nil)

    Optional. If true, the response will include soft-deleted versions of the schema, even if the subject is soft-deleted. The default is false.

  • subject (String) (defaults to: nil)

    Optional. The subject to filter the subjects by.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
# File 'lib/google/apis/managedkafka_v1/service.rb', line 3110

def list_project_location_schema_registry_schema_versions(parent, deleted: nil, subject: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/versions', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::HttpBody::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.query['deleted'] = deleted unless deleted.nil?
  command.query['subject'] = subject unless subject.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_schema_registry_subject_version_referencedbies(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::HttpBody

Get a list of IDs of schemas that reference the schema with the given subject and version.

Parameters:

  • parent (String)

    Required. The version to list referenced by. Structured like: projects/ project/locations/location/schemaRegistries/schema_registry/subjects/ subject/versions/versionor `projects/`project`/locations/`location`/ schemaRegistries/`schema_registry`/contexts/`context`/subjects/`subject`/ versions/`version

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3462
3463
3464
3465
3466
3467
3468
3469
3470
# File 'lib/google/apis/managedkafka_v1/service.rb', line 3462

def list_project_location_schema_registry_subject_version_referencedbies(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/referencedby', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::HttpBody::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_schema_registry_subject_versions(parent, deleted: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::HttpBody

Get all versions of a subject. The response will be an array of versions of the subject.

Parameters:

  • parent (String)

    Required. The subject whose versions are to be listed. Structured like: projects/project/locations/location/schemaRegistries/schema_registry/ subjects/subjector `projects/`project`/locations/`location`/ schemaRegistries/`schema_registry`/contexts/`context`/subjects/`subject

  • deleted (Boolean) (defaults to: nil)

    Optional. If true, the response will include soft-deleted versions of an active or soft-deleted subject. The default is false.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
# File 'lib/google/apis/managedkafka_v1/service.rb', line 3426

def list_project_location_schema_registry_subject_versions(parent, deleted: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/versions', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::HttpBody::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.query['deleted'] = deleted unless deleted.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_schema_registry_subjects(parent, deleted: nil, subject_prefix: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::HttpBody

List subjects in the schema registry. The response will be an array of subject names.

Parameters:

  • parent (String)

    Required. The parent schema registry/context whose subjects are to be listed. Structured like: projects/project/locations/location/schemaRegistries/ schema_registryor `projects/`project`/locations/`location`/schemaRegistries/ `schema_registry`/contexts/`context

  • deleted (Boolean) (defaults to: nil)

    Optional. If true, the response will include soft-deleted subjects. The default is false.

  • subject_prefix (String) (defaults to: nil)

    Optional. The context to filter the subjects by, in the format of :.context: . If unset, all subjects in the registry are returned. Set to empty string or add as '?subjectPrefix=' at the end of this request to list subjects in the default context.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
# File 'lib/google/apis/managedkafka_v1/service.rb', line 3195

def list_project_location_schema_registry_subjects(parent, deleted: nil, subject_prefix: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/subjects', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::HttpBody::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.query['deleted'] = deleted unless deleted.nil?
  command.query['subjectPrefix'] = subject_prefix unless subject_prefix.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::ListLocationsResponse

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ ListLocationsRequest.name] field: * Global locations: If name is empty, the method lists the public locations available to all projects. * Project- specific locations: If name follows the format projects/project`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as thename` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

Parameters:

  • name (String)

    The resource that owns the locations collection, if applicable.

  • extra_location_types (Array<String>, String) (defaults to: nil)

    Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.

  • filter (String) (defaults to: nil)

    A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of results to return. If not set, the service selects a default.

  • page_token (String) (defaults to: nil)

    A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'lib/google/apis/managedkafka_v1/service.rb', line 126

def list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/locations', options)
  command.response_representation = Google::Apis::ManagedkafkaV1::ListLocationsResponse::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::ListLocationsResponse
  command.params['name'] = name unless name.nil?
  command.query['extraLocationTypes'] = extra_location_types unless extra_location_types.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#lookup_project_location_schema_registry_context_subject_version(parent, lookup_version_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::SchemaVersion

Lookup a schema under the specified subject.

Parameters:

  • parent (String)

    Required. The subject to lookup the schema in. Structured like: projects/ project/locations/location/schemaRegistries/schema_registry/subjects/ subjector `projects/`project`/locations/`location`/schemaRegistries/` schema_registry`/contexts/`context`/subjects/`subject

  • lookup_version_request_object (Google::Apis::ManagedkafkaV1::LookupVersionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
# File 'lib/google/apis/managedkafka_v1/service.rb', line 2586

def lookup_project_location_schema_registry_context_subject_version(parent, lookup_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}', options)
  command.request_representation = Google::Apis::ManagedkafkaV1::LookupVersionRequest::Representation
  command.request_object = lookup_version_request_object
  command.response_representation = Google::Apis::ManagedkafkaV1::SchemaVersion::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::SchemaVersion
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#lookup_project_location_schema_registry_subject_version(parent, lookup_version_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::SchemaVersion

Lookup a schema under the specified subject.

Parameters:

  • parent (String)

    Required. The subject to lookup the schema in. Structured like: projects/ project/locations/location/schemaRegistries/schema_registry/subjects/ subjector `projects/`project`/locations/`location`/schemaRegistries/` schema_registry`/contexts/`context`/subjects/`subject

  • lookup_version_request_object (Google::Apis::ManagedkafkaV1::LookupVersionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
# File 'lib/google/apis/managedkafka_v1/service.rb', line 3231

def lookup_project_location_schema_registry_subject_version(parent, lookup_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}', options)
  command.request_representation = Google::Apis::ManagedkafkaV1::LookupVersionRequest::Representation
  command.request_object = lookup_version_request_object
  command.response_representation = Google::Apis::ManagedkafkaV1::SchemaVersion::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::SchemaVersion
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_cluster(name, cluster_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::Operation

Updates the properties of a single cluster.

Parameters:

  • name (String)

    Identifier. The name of the cluster. Structured like: projects/project_number /locations/location/clusters/cluster_id

  • cluster_object (Google::Apis::ManagedkafkaV1::Cluster) (defaults to: nil)
  • 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).

  • update_mask (String) (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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



353
354
355
356
357
358
359
360
361
362
363
364
365
# File 'lib/google/apis/managedkafka_v1/service.rb', line 353

def patch_project_location_cluster(name, cluster_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ManagedkafkaV1::Cluster::Representation
  command.request_object = cluster_object
  command.response_representation = Google::Apis::ManagedkafkaV1::Operation::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_cluster_acl(name, acl_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::Acl

Updates the properties of a single acl.

Parameters:

  • name (String)

    Identifier. The name for the acl. Represents a single Resource Pattern. Structured like: projects/project/locations/location/clusters/cluster/ acls/acl_id The structure of acl_id defines the Resource Pattern ( resource_type, resource_name, pattern_type) of the acl. acl_id is structured like one of the following: For acls on the cluster: cluster For acls on a single resource within the cluster: topic/resource_name`consumerGroup/` resource_name transactionalId/resource_nameFor acls on all resources that match a prefix: `topicPrefixed/`resource_name consumerGroupPrefixed/ resource_name`transactionalIdPrefixed/`resource_name For acls on all resources of a given type (i.e. the wildcard literal ""): allTopics ( represents `topic/)allConsumerGroups(representsconsumerGroup/) allTransactionalIds(representstransactionalId/`)

  • acl_object (Google::Apis::ManagedkafkaV1::Acl) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. Field mask is used to specify the fields to be overwritten in the Acl 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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



594
595
596
597
598
599
600
601
602
603
604
605
# File 'lib/google/apis/managedkafka_v1/service.rb', line 594

def patch_project_location_cluster_acl(name, acl_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ManagedkafkaV1::Acl::Representation
  command.request_object = acl_object
  command.response_representation = Google::Apis::ManagedkafkaV1::Acl::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::Acl
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_cluster_consumer_group(name, consumer_group_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::ConsumerGroup

Updates the properties of a single consumer group.

Parameters:

  • name (String)

    Identifier. The name of the consumer group. The consumer_group segment is used when connecting directly to the cluster. Structured like: projects/ project/locations/location/clusters/cluster/consumerGroups/ consumer_group

  • consumer_group_object (Google::Apis::ManagedkafkaV1::ConsumerGroup) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. Field mask is used to specify the fields to be overwritten in the ConsumerGroup 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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



788
789
790
791
792
793
794
795
796
797
798
799
# File 'lib/google/apis/managedkafka_v1/service.rb', line 788

def patch_project_location_cluster_consumer_group(name, consumer_group_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ManagedkafkaV1::ConsumerGroup::Representation
  command.request_object = consumer_group_object
  command.response_representation = Google::Apis::ManagedkafkaV1::ConsumerGroup::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::ConsumerGroup
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_cluster_topic(name, topic_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::Topic

Updates the properties of a single topic.

Parameters:

  • name (String)

    Identifier. The name of the topic. The topic segment is used when connecting directly to the cluster. Structured like: projects/project/locations/ location/clusters/cluster/topics/topic

  • topic_object (Google::Apis::ManagedkafkaV1::Topic) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. Field mask is used to specify the fields to be overwritten in the Topic 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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



970
971
972
973
974
975
976
977
978
979
980
981
# File 'lib/google/apis/managedkafka_v1/service.rb', line 970

def patch_project_location_cluster_topic(name, topic_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ManagedkafkaV1::Topic::Representation
  command.request_object = topic_object
  command.response_representation = Google::Apis::ManagedkafkaV1::Topic::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::Topic
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_connect_cluster(name, connect_cluster_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::Operation

Updates the properties of a single Kafka Connect cluster.

Parameters:

  • name (String)

    Identifier. The name of the Kafka Connect cluster. Structured like: projects/ project_number/locations/location/connectClusters/connect_cluster_id

  • connect_cluster_object (Google::Apis::ManagedkafkaV1::ConnectCluster) (defaults to: nil)
  • 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).

  • update_mask (String) (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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
# File 'lib/google/apis/managedkafka_v1/service.rb', line 1197

def patch_project_location_connect_cluster(name, connect_cluster_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ManagedkafkaV1::ConnectCluster::Representation
  command.request_object = connect_cluster_object
  command.response_representation = Google::Apis::ManagedkafkaV1::Operation::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_connect_cluster_connector(name, connector_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::Connector

Updates the properties of a connector.

Parameters:

  • name (String)

    Identifier. The name of the connector. Structured like: projects/project/ locations/location/connectClusters/connect_cluster/connectors/connector

  • connector_object (Google::Apis::ManagedkafkaV1::Connector) (defaults to: nil)
  • update_mask (String) (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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
# File 'lib/google/apis/managedkafka_v1/service.rb', line 1386

def patch_project_location_connect_cluster_connector(name, connector_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ManagedkafkaV1::Connector::Representation
  command.request_object = connector_object
  command.response_representation = Google::Apis::ManagedkafkaV1::Connector::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::Connector
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#pause_connector(name, pause_connector_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::PauseConnectorResponse

Pauses the connector and its tasks.

Parameters:

  • name (String)

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

  • pause_connector_request_object (Google::Apis::ManagedkafkaV1::PauseConnectorRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'lib/google/apis/managedkafka_v1/service.rb', line 1422

def pause_connector(name, pause_connector_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:pause', options)
  command.request_representation = Google::Apis::ManagedkafkaV1::PauseConnectorRequest::Representation
  command.request_object = pause_connector_request_object
  command.response_representation = Google::Apis::ManagedkafkaV1::PauseConnectorResponse::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::PauseConnectorResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#remove_project_location_cluster_acl_acl_entry(acl, acl_entry_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::RemoveAclEntryResponse

Incremental update: Removes an acl entry from an acl. Deletes the acl if its acl entries become empty (i.e. if the removed entry was the last one in the acl).

Parameters:

  • acl (String)

    Required. The name of the acl to remove the acl entry from. Structured like: projects/project/locations/location/clusters/cluster/acls/acl_id`. The structure ofacl_iddefines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. SeeAcl.name` for details.

  • acl_entry_object (Google::Apis::ManagedkafkaV1::AclEntry) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



633
634
635
636
637
638
639
640
641
642
643
# File 'lib/google/apis/managedkafka_v1/service.rb', line 633

def remove_project_location_cluster_acl_acl_entry(acl, acl_entry_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+acl}:removeAclEntry', options)
  command.request_representation = Google::Apis::ManagedkafkaV1::AclEntry::Representation
  command.request_object = acl_entry_object
  command.response_representation = Google::Apis::ManagedkafkaV1::RemoveAclEntryResponse::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::RemoveAclEntryResponse
  command.params['acl'] = acl unless acl.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#restart_connector(name, restart_connector_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::RestartConnectorResponse

Restarts the connector.

Parameters:

  • name (String)

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

  • restart_connector_request_object (Google::Apis::ManagedkafkaV1::RestartConnectorRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
# File 'lib/google/apis/managedkafka_v1/service.rb', line 1457

def restart_connector(name, restart_connector_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:restart', options)
  command.request_representation = Google::Apis::ManagedkafkaV1::RestartConnectorRequest::Representation
  command.request_object = restart_connector_request_object
  command.response_representation = Google::Apis::ManagedkafkaV1::RestartConnectorResponse::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::RestartConnectorResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#resume_connector(name, resume_connector_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::ResumeConnectorResponse

Resumes the connector and its tasks.

Parameters:

  • name (String)

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

  • resume_connector_request_object (Google::Apis::ManagedkafkaV1::ResumeConnectorRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
# File 'lib/google/apis/managedkafka_v1/service.rb', line 1492

def resume_connector(name, resume_connector_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:resume', options)
  command.request_representation = Google::Apis::ManagedkafkaV1::ResumeConnectorRequest::Representation
  command.request_object = resume_connector_request_object
  command.response_representation = Google::Apis::ManagedkafkaV1::ResumeConnectorResponse::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::ResumeConnectorResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#stop_connector(name, stop_connector_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::StopConnectorResponse

Stops the connector.

Parameters:

  • name (String)

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

  • stop_connector_request_object (Google::Apis::ManagedkafkaV1::StopConnectorRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
# File 'lib/google/apis/managedkafka_v1/service.rb', line 1527

def stop_connector(name, stop_connector_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:stop', options)
  command.request_representation = Google::Apis::ManagedkafkaV1::StopConnectorRequest::Representation
  command.request_object = stop_connector_request_object
  command.response_representation = Google::Apis::ManagedkafkaV1::StopConnectorResponse::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::StopConnectorResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_project_location_schema_registry_config(name, update_schema_config_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::SchemaConfig

Update config at global level or for a subject. Creates a SchemaSubject-level SchemaConfig if it does not exist.

Parameters:

  • name (String)

    Required. The resource name to update the config for. It can be either of following: * projects/project/locations/location/schemaRegistries/ schema_registry/config: Update config at global level. * projects/project/ locations/location/schemaRegistries/schema_registry/config/subject: Update config for a specific subject.

  • update_schema_config_request_object (Google::Apis::ManagedkafkaV1::UpdateSchemaConfigRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
# File 'lib/google/apis/managedkafka_v1/service.rb', line 1959

def update_project_location_schema_registry_config(name, update_schema_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ManagedkafkaV1::UpdateSchemaConfigRequest::Representation
  command.request_object = update_schema_config_request_object
  command.response_representation = Google::Apis::ManagedkafkaV1::SchemaConfig::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::SchemaConfig
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_project_location_schema_registry_context_config(name, update_schema_config_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::SchemaConfig

Update config at global level or for a subject. Creates a SchemaSubject-level SchemaConfig if it does not exist.

Parameters:

  • name (String)

    Required. The resource name to update the config for. It can be either of following: * projects/project/locations/location/schemaRegistries/ schema_registry/config: Update config at global level. * projects/project/ locations/location/schemaRegistries/schema_registry/config/subject: Update config for a specific subject.

  • update_schema_config_request_object (Google::Apis::ManagedkafkaV1::UpdateSchemaConfigRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
# File 'lib/google/apis/managedkafka_v1/service.rb', line 2170

def update_project_location_schema_registry_context_config(name, update_schema_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ManagedkafkaV1::UpdateSchemaConfigRequest::Representation
  command.request_object = update_schema_config_request_object
  command.response_representation = Google::Apis::ManagedkafkaV1::SchemaConfig::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::SchemaConfig
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_project_location_schema_registry_context_mode(name, update_schema_mode_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::SchemaMode

Update mode at global level or for a subject.

Parameters:

  • name (String)

    Required. The resource name of the mode. The format is * projects/project/ locations/location/schemaRegistries/schema_registry/mode/subject: mode for a schema registry, or * projects/project/locations/location/ schemaRegistries/schema_registry/contexts/context/mode/subject: mode for a specific subject in a specific context

  • update_schema_mode_request_object (Google::Apis::ManagedkafkaV1::UpdateSchemaModeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
# File 'lib/google/apis/managedkafka_v1/service.rb', line 2274

def update_project_location_schema_registry_context_mode(name, update_schema_mode_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ManagedkafkaV1::UpdateSchemaModeRequest::Representation
  command.request_object = update_schema_mode_request_object
  command.response_representation = Google::Apis::ManagedkafkaV1::SchemaMode::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::SchemaMode
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_project_location_schema_registry_mode(name, update_schema_mode_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManagedkafkaV1::SchemaMode

Update mode at global level or for a subject.

Parameters:

  • name (String)

    Required. The resource name of the mode. The format is * projects/project/ locations/location/schemaRegistries/schema_registry/mode/subject: mode for a schema registry, or * projects/project/locations/location/ schemaRegistries/schema_registry/contexts/context/mode/subject: mode for a specific subject in a specific context

  • update_schema_mode_request_object (Google::Apis::ManagedkafkaV1::UpdateSchemaModeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
# File 'lib/google/apis/managedkafka_v1/service.rb', line 2919

def update_project_location_schema_registry_mode(name, update_schema_mode_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ManagedkafkaV1::UpdateSchemaModeRequest::Representation
  command.request_object = update_schema_mode_request_object
  command.response_representation = Google::Apis::ManagedkafkaV1::SchemaMode::Representation
  command.response_class = Google::Apis::ManagedkafkaV1::SchemaMode
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end