Class: Google::Cloud::PubSub::V1::SchemaService::Client
- Inherits:
-
Object
- Object
- Google::Cloud::PubSub::V1::SchemaService::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/pubsub/v1/schema_service/client.rb
Overview
Client for the SchemaService service.
Service for doing schema-related operations.
Defined Under Namespace
Classes: Configuration
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the SchemaService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the SchemaService Client instance.
-
#create_schema(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::PubSub::V1::Schema
Creates a schema.
-
#delete_schema(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a schema.
-
#get_schema(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::PubSub::V1::Schema
Gets a schema.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new SchemaService client object.
-
#list_schemas(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::PubSub::V1::Schema>
Lists schemas in a project.
-
#validate_message(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::PubSub::V1::ValidateMessageResponse
Validates a message against a schema.
-
#validate_schema(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::PubSub::V1::ValidateSchemaResponse
Validates a schema.
Methods included from Paths
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new SchemaService client object.
Examples
To create a new SchemaService client with the default configuration:
client = ::Google::Cloud::PubSub::V1::SchemaService::Client.new
To create a new SchemaService client with a custom configuration:
client = ::Google::Cloud::PubSub::V1::SchemaService::Client.new do |config|
config.timeout = 10.0
end
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 |
# File 'lib/google/cloud/pubsub/v1/schema_service/client.rb', line 114 def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/pubsub/v1/schema_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the scope and endpoint are unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.scope == Client.configure.scope && @config.endpoint == Client.configure.endpoint && !@config.endpoint.split(".").first.include?("-") credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(String) || credentials.is_a?(Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @schema_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::PubSub::V1::SchemaService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the SchemaService Client class.
See Configuration for a description of the configuration fields.
Example
To modify the configuration for all SchemaService clients:
::Google::Cloud::PubSub::V1::SchemaService::Client.configure do |config|
config.timeout = 10.0
end
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 |
# File 'lib/google/cloud/pubsub/v1/schema_service/client.rb', line 57 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "PubSub", "V1"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config end yield @configure if block_given? @configure end |
Instance Method Details
#configure {|config| ... } ⇒ Client::Configuration
Configure the SchemaService Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.
See Configuration for a description of the configuration fields.
89 90 91 92 |
# File 'lib/google/cloud/pubsub/v1/schema_service/client.rb', line 89 def configure yield @config if block_given? @config end |
#create_schema(request, options = nil) ⇒ ::Google::Cloud::PubSub::V1::Schema #create_schema(parent: nil, schema: nil, schema_id: nil) ⇒ ::Google::Cloud::PubSub::V1::Schema
Creates a schema.
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 |
# File 'lib/google/cloud/pubsub/v1/schema_service/client.rb', line 195 def create_schema request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::PubSub::V1::CreateSchemaRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.create_schema..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::PubSub::V1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.create_schema.timeout, metadata: , retry_policy: @config.rpcs.create_schema.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @schema_service_stub.call_rpc :create_schema, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#delete_schema(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_schema(name: nil) ⇒ ::Google::Protobuf::Empty
Deletes a schema.
411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 |
# File 'lib/google/cloud/pubsub/v1/schema_service/client.rb', line 411 def delete_schema request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::PubSub::V1::DeleteSchemaRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.delete_schema..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::PubSub::V1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.delete_schema.timeout, metadata: , retry_policy: @config.rpcs.delete_schema.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @schema_service_stub.call_rpc :delete_schema, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#get_schema(request, options = nil) ⇒ ::Google::Cloud::PubSub::V1::Schema #get_schema(name: nil, view: nil) ⇒ ::Google::Cloud::PubSub::V1::Schema
Gets a schema.
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 |
# File 'lib/google/cloud/pubsub/v1/schema_service/client.rb', line 266 def get_schema request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::PubSub::V1::GetSchemaRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_schema..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::PubSub::V1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.get_schema.timeout, metadata: , retry_policy: @config.rpcs.get_schema.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @schema_service_stub.call_rpc :get_schema, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#list_schemas(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::PubSub::V1::Schema> #list_schemas(parent: nil, view: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::PubSub::V1::Schema>
Lists schemas in a project.
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 |
# File 'lib/google/cloud/pubsub/v1/schema_service/client.rb', line 343 def list_schemas request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::PubSub::V1::ListSchemasRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.list_schemas..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::PubSub::V1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.list_schemas.timeout, metadata: , retry_policy: @config.rpcs.list_schemas.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @schema_service_stub.call_rpc :list_schemas, request, options: do |response, operation| response = ::Gapic::PagedEnumerable.new @schema_service_stub, :list_schemas, request, response, operation, yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#validate_message(request, options = nil) ⇒ ::Google::Cloud::PubSub::V1::ValidateMessageResponse #validate_message(parent: nil, name: nil, schema: nil, message: nil, encoding: nil) ⇒ ::Google::Cloud::PubSub::V1::ValidateMessageResponse
Validates a message against a schema.
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 |
# File 'lib/google/cloud/pubsub/v1/schema_service/client.rb', line 557 def request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::PubSub::V1::ValidateMessageRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs...to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::PubSub::V1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs..timeout, metadata: , retry_policy: @config.rpcs..retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @schema_service_stub.call_rpc :validate_message, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#validate_schema(request, options = nil) ⇒ ::Google::Cloud::PubSub::V1::ValidateSchemaResponse #validate_schema(parent: nil, schema: nil) ⇒ ::Google::Cloud::PubSub::V1::ValidateSchemaResponse
Validates a schema.
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 |
# File 'lib/google/cloud/pubsub/v1/schema_service/client.rb', line 480 def validate_schema request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::PubSub::V1::ValidateSchemaRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.validate_schema..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::PubSub::V1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.validate_schema.timeout, metadata: , retry_policy: @config.rpcs.validate_schema.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @schema_service_stub.call_rpc :validate_schema, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |