Class: Google::Cloud::Talent::V4beta1::ProfileService::Client
- Inherits:
-
Object
- Object
- Google::Cloud::Talent::V4beta1::ProfileService::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/talent/v4beta1/profile_service/client.rb
Overview
Client for the ProfileService service.
A service that handles profile management, including profile CRUD, enumeration and search.
Defined Under Namespace
Classes: Configuration
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the ProfileService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the ProfileService Client instance.
-
#create_profile(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Talent::V4beta1::Profile
Creates and returns a new profile.
-
#delete_profile(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes the specified profile.
-
#get_profile(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Talent::V4beta1::Profile
Gets the specified profile.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new ProfileService client object.
-
#list_profiles(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Talent::V4beta1::Profile>
Lists profiles by filter.
-
#search_profiles(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Talent::V4beta1::SearchProfilesResponse
Searches for profiles within a tenant.
-
#update_profile(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Talent::V4beta1::Profile
Updates the specified profile and returns the updated result.
Methods included from Paths
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new ProfileService client object.
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 |
# File 'lib/google/cloud/talent/v4beta1/profile_service/client.rb', line 131 def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/cloud/talent/v4beta1/profile_service_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint == 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 @profile_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Talent::V4beta1::ProfileService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the ProfileService Client class.
See Configuration for a description of the configuration fields.
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 |
# File 'lib/google/cloud/talent/v4beta1/profile_service/client.rb', line 57 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Talent", "V4beta1"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.rpcs.list_profiles.timeout = 30.0 default_config.rpcs.list_profiles.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.create_profile.timeout = 30.0 default_config.rpcs.get_profile.timeout = 30.0 default_config.rpcs.get_profile.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.update_profile.timeout = 30.0 default_config.rpcs.delete_profile.timeout = 30.0 default_config.rpcs.delete_profile.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.search_profiles.timeout = 30.0 default_config end yield @configure if block_given? @configure end |
Instance Method Details
#configure {|config| ... } ⇒ Client::Configuration
Configure the ProfileService 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.
110 111 112 113 |
# File 'lib/google/cloud/talent/v4beta1/profile_service/client.rb', line 110 def configure yield @config if block_given? @config end |
#create_profile(request, options = nil) ⇒ ::Google::Cloud::Talent::V4beta1::Profile #create_profile(parent: nil, profile: nil) ⇒ ::Google::Cloud::Talent::V4beta1::Profile
Creates and returns a new profile.
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 380 381 382 383 384 385 386 |
# File 'lib/google/cloud/talent/v4beta1/profile_service/client.rb', line 347 def create_profile request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4beta1::CreateProfileRequest # 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_profile..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::Talent::V4beta1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.create_profile.timeout, metadata: , retry_policy: @config.rpcs.create_profile.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @profile_service_stub.call_rpc :create_profile, 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_profile(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_profile(name: nil) ⇒ ::Google::Protobuf::Empty
Deletes the specified profile. Prerequisite: The profile has no associated applications or assignments associated.
616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 |
# File 'lib/google/cloud/talent/v4beta1/profile_service/client.rb', line 616 def delete_profile request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4beta1::DeleteProfileRequest # 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_profile..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::Talent::V4beta1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.delete_profile.timeout, metadata: , retry_policy: @config.rpcs.delete_profile.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @profile_service_stub.call_rpc :delete_profile, 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_profile(request, options = nil) ⇒ ::Google::Cloud::Talent::V4beta1::Profile #get_profile(name: nil) ⇒ ::Google::Cloud::Talent::V4beta1::Profile
Gets the specified profile.
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 |
# File 'lib/google/cloud/talent/v4beta1/profile_service/client.rb', line 436 def get_profile request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4beta1::GetProfileRequest # 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_profile..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::Talent::V4beta1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.get_profile.timeout, metadata: , retry_policy: @config.rpcs.get_profile.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @profile_service_stub.call_rpc :get_profile, 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_profiles(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Talent::V4beta1::Profile> #list_profiles(parent: nil, filter: nil, page_token: nil, page_size: nil, read_mask: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Talent::V4beta1::Profile>
Lists profiles by filter. The order is unspecified.
256 257 258 259 260 261 262 263 264 265 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 |
# File 'lib/google/cloud/talent/v4beta1/profile_service/client.rb', line 256 def list_profiles request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4beta1::ListProfilesRequest # 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_profiles..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::Talent::V4beta1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.list_profiles.timeout, metadata: , retry_policy: @config.rpcs.list_profiles.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @profile_service_stub.call_rpc :list_profiles, request, options: do |response, operation| response = ::Gapic::PagedEnumerable.new @profile_service_stub, :list_profiles, request, response, operation, yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#search_profiles(request, options = nil) ⇒ ::Google::Cloud::Talent::V4beta1::SearchProfilesResponse #search_profiles(parent: nil, request_metadata: nil, profile_query: nil, page_size: nil, page_token: nil, offset: nil, disable_spell_check: nil, order_by: nil, case_sensitive_sort: nil, histogram_queries: nil, result_set_id: nil, strict_keywords_search: nil) ⇒ ::Google::Cloud::Talent::V4beta1::SearchProfilesResponse
Searches for profiles within a tenant.
For example, search by raw queries "software engineer in Mountain View" or search by structured filters (location filter, education filter, etc.).
See SearchProfilesRequest for more information.
876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 |
# File 'lib/google/cloud/talent/v4beta1/profile_service/client.rb', line 876 def search_profiles request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4beta1::SearchProfilesRequest # 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.search_profiles..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::Talent::V4beta1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.search_profiles.timeout, metadata: , retry_policy: @config.rpcs.search_profiles.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @profile_service_stub.call_rpc :search_profiles, 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 |
#update_profile(request, options = nil) ⇒ ::Google::Cloud::Talent::V4beta1::Profile #update_profile(profile: nil, update_mask: nil) ⇒ ::Google::Cloud::Talent::V4beta1::Profile
Updates the specified profile and returns the updated result.
525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 |
# File 'lib/google/cloud/talent/v4beta1/profile_service/client.rb', line 525 def update_profile request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4beta1::UpdateProfileRequest # 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.update_profile..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::Talent::V4beta1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.profile&.name header_params["profile.name"] = request.profile.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.update_profile.timeout, metadata: , retry_policy: @config.rpcs.update_profile.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @profile_service_stub.call_rpc :update_profile, 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 |