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

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

List profiles request.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
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"

#filter=

def filter=(value) -> ::String
Parameter
  • value (::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"
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"

#page_size

def page_size() -> ::Integer
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.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.

#page_token

def page_token() -> ::String
Returns

#page_token=

def page_token=(value) -> ::String
Parameter
Returns

#parent

def parent() -> ::String
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".

#parent=

def parent=(value) -> ::String
Parameter
  • value (::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".

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".

#read_mask

def read_mask() -> ::Google::Protobuf::FieldMask
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

#read_mask=

def read_mask=(value) -> ::Google::Protobuf::FieldMask
Parameter
  • value (::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
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