Class: Google::Cloud::Talent::V4beta1::ListProfilesRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/profile_service.rb

Overview

List profiles request.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ String

Returns The filter string specifies the profiles to be enumerated.

Supported operator: =, AND

The field(s) eligible for filtering are:

  • externalId
  • groupId

externalId and groupId cannot be specified at the same time. If both externalId and groupId are provided, the API will return a bad request error.

Sample Query:

  • externalId = "externalId-1"
  • groupId = "groupId-1".

Returns:

  • (String) —

    The filter string specifies the profiles to be enumerated.

    Supported operator: =, AND

    The field(s) eligible for filtering are:

    • externalId
    • groupId

    externalId and groupId cannot be specified at the same time. If both externalId and groupId are provided, the API will return a bad request error.

    Sample Query:

    • externalId = "externalId-1"
    • groupId = "groupId-1"


67
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/profile_service.rb', line 67

class ListProfilesRequest; end

#page_size ⇒ Integer

Returns The maximum number of profiles to be returned, at most 100.

Default is 100 unless a positive number smaller than 100 is specified.

Returns:

  • (Integer) —

    The maximum number of profiles to be returned, at most 100.

    Default is 100 unless a positive number smaller than 100 is specified.



67
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/profile_service.rb', line 67

class ListProfilesRequest; end

#page_token ⇒ String

Returns The token that specifies the current offset (that is, starting result).

Please set the value to ListProfilesResponse#next_page_token to continue the list.

Returns:



67
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/profile_service.rb', line 67

class ListProfilesRequest; end

#parent ⇒ String

Returns Required. The resource name of the tenant under which the profile is created.

The format is "projects/project_id/tenants/tenant_id". For example, "projects/foo/tenants/bar".

Returns:

  • (String) —

    Required. The resource name of the tenant under which the profile is created.

    The format is "projects/project_id/tenants/tenant_id". For example, "projects/foo/tenants/bar".



67
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/profile_service.rb', line 67

class ListProfilesRequest; end

#read_mask ⇒ Google::Protobuf::FieldMask

Returns A field mask to specify the profile fields to be listed in response. All fields are listed if it is unset.

Valid values are:

  • name.

Returns:

  • (Google::Protobuf::FieldMask) —

    A field mask to specify the profile fields to be listed in response. All fields are listed if it is unset.

    Valid values are:

    • name


67
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/profile_service.rb', line 67

class ListProfilesRequest; end