Cloud Talent Solution V4beta1 API - Class Google::Cloud::Talent::V4beta1::ApplicationService::Client (v0.4.6)

Reference documentation and code samples for the Cloud Talent Solution V4beta1 API class Google::Cloud::Talent::V4beta1::ApplicationService::Client.

Client for the ApplicationService service.

A service that handles application management, including CRUD and enumeration.

Inherits

Object

Includes

Google::Cloud::Talent::V4beta1::ApplicationService::Paths

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the ApplicationService Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

# Modify the configuration for all ApplicationService clients
::Google::Cloud::Talent::V4beta1::ApplicationService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the ApplicationService 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 Client.configure.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

#create_application

def create_application(request, options = nil) -> ::Google::Cloud::Talent::V4beta1::Application
def create_application(parent: nil, application: nil) -> ::Google::Cloud::Talent::V4beta1::Application

Creates a new application entity.

Overloads

def create_application(request, options = nil) -> ::Google::Cloud::Talent::V4beta1::Application

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

Parameters

request (::Google::Cloud::Talent::V4beta1::CreateApplicationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def create_application(parent: nil, application: nil) -> ::Google::Cloud::Talent::V4beta1::Application

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

Parameters

parent (::String) — Required. Resource name of the profile under which the application is created.

The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}". For example, "projects/foo/tenants/bar/profiles/baz".
application (::Google::Cloud::Talent::V4beta1::Application, ::Hash) — Required. The application to be created.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Talent::V4beta1::Application)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Talent::V4beta1::Application)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/talent/v4beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Talent::V4beta1::ApplicationService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Talent::V4beta1::CreateApplicationRequest.new

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

# The returned object is of type Google::Cloud::Talent::V4beta1::Application.
p result

#delete_application

def delete_application(request, options = nil) -> ::Google::Protobuf::Empty
def delete_application(name: nil) -> ::Google::Protobuf::Empty

Deletes specified application.

Overloads

def delete_application(request, options = nil) -> ::Google::Protobuf::Empty

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

Parameters

request (::Google::Cloud::Talent::V4beta1::DeleteApplicationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def delete_application(name: nil) -> ::Google::Protobuf::Empty

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

Parameter

name (::String) — Required. The resource name of the application to be deleted.

The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}/applications/{application_id}". For example, "projects/foo/tenants/bar/profiles/baz/applications/qux".

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Protobuf::Empty)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/talent/v4beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Talent::V4beta1::ApplicationService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Talent::V4beta1::DeleteApplicationRequest.new

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

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

#get_application

def get_application(request, options = nil) -> ::Google::Cloud::Talent::V4beta1::Application
def get_application(name: nil) -> ::Google::Cloud::Talent::V4beta1::Application

Retrieves specified application.

Overloads

def get_application(request, options = nil) -> ::Google::Cloud::Talent::V4beta1::Application

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

Parameters

request (::Google::Cloud::Talent::V4beta1::GetApplicationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_application(name: nil) -> ::Google::Cloud::Talent::V4beta1::Application

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

Parameter

name (::String) — Required. The resource name of the application to be retrieved.

The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}/applications/{application_id}". For example, "projects/foo/tenants/bar/profiles/baz/applications/qux".

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Talent::V4beta1::Application)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Talent::V4beta1::Application)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/talent/v4beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Talent::V4beta1::ApplicationService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Talent::V4beta1::GetApplicationRequest.new

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

# The returned object is of type Google::Cloud::Talent::V4beta1::Application.
p result

#initialize

def initialize() { |config| ... } -> Client

Create a new ApplicationService client object.

Yields

(config) — Configure the ApplicationService client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::Talent::V4beta1::ApplicationService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Talent::V4beta1::ApplicationService::Client.new do |config|
  config.timeout = 10.0
end

#list_applications

def list_applications(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Talent::V4beta1::Application>
def list_applications(parent: nil, page_token: nil, page_size: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Talent::V4beta1::Application>

Lists all applications associated with the profile.

Overloads

def list_applications(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Talent::V4beta1::Application>

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

Parameters

request (::Google::Cloud::Talent::V4beta1::ListApplicationsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_applications(parent: nil, page_token: nil, page_size: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Talent::V4beta1::Application>

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

Parameters

parent (::String) — Required. Resource name of the profile under which the application is created.

The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}", for example, "projects/foo/tenants/bar/profiles/baz".
page_token (::String) — The starting indicator from which to return results.
page_size (::Integer) — The maximum number of applications to be returned, at most 100. Default is 100 if a non-positive number is provided.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::Talent::V4beta1::Application>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::Talent::V4beta1::Application>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/talent/v4beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Talent::V4beta1::ApplicationService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Talent::V4beta1::ListApplicationsRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Cloud::Talent::V4beta1::Application.
  p response
end

#update_application

def update_application(request, options = nil) -> ::Google::Cloud::Talent::V4beta1::Application
def update_application(application: nil, update_mask: nil) -> ::Google::Cloud::Talent::V4beta1::Application

Updates specified application.

Overloads

def update_application(request, options = nil) -> ::Google::Cloud::Talent::V4beta1::Application

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

Parameters

request (::Google::Cloud::Talent::V4beta1::UpdateApplicationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def update_application(application: nil, update_mask: nil) -> ::Google::Cloud::Talent::V4beta1::Application

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

Parameters

application (::Google::Cloud::Talent::V4beta1::Application, ::Hash) — Required. The application resource to replace the current resource in the system.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — Strongly recommended for the best service experience.

If update_mask is provided, only the specified fields in application are updated. Otherwise all the fields are updated.

A field mask to specify the application fields to be updated. Only top level fields of Application are supported.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Talent::V4beta1::Application)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Talent::V4beta1::Application)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/talent/v4beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Talent::V4beta1::ApplicationService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Talent::V4beta1::UpdateApplicationRequest.new

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

# The returned object is of type Google::Cloud::Talent::V4beta1::Application.
p result