Class: Google::Cloud::Talent::V4beta1::ListProfilesRequest
- Inherits:
-
Object
- Object
- Google::Cloud::Talent::V4beta1::ListProfilesRequest
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/talent/v4beta1/profile_service.rb
Overview
List profiles request.
Instance Attribute Summary collapse
-
#filter ⇒ ::String
The filter string specifies the profiles to be enumerated.
-
#page_size ⇒ ::Integer
The maximum number of profiles to be returned, at most 100.
-
#page_token ⇒ ::String
The token that specifies the current offset (that is, starting result).
-
#parent ⇒ ::String
Required.
-
#read_mask ⇒ ::Google::Protobuf::FieldMask
A field mask to specify the profile fields to be listed in response.
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".
69 70 71 72 |
# File 'proto_docs/google/cloud/talent/v4beta1/profile_service.rb', line 69 class ListProfilesRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods 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.
69 70 71 72 |
# File 'proto_docs/google/cloud/talent/v4beta1/profile_service.rb', line 69 class ListProfilesRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods 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.
69 70 71 72 |
# File 'proto_docs/google/cloud/talent/v4beta1/profile_service.rb', line 69 class ListProfilesRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods 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".
69 70 71 72 |
# File 'proto_docs/google/cloud/talent/v4beta1/profile_service.rb', line 69 class ListProfilesRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods 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.
69 70 71 72 |
# File 'proto_docs/google/cloud/talent/v4beta1/profile_service.rb', line 69 class ListProfilesRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |