Class ListProfilesRequest.Builder

Stay organized with collections Save and categorize content based on your preferences.
public static final class ListProfilesRequest.Builder extends GeneratedMessageV3.Builder<ListProfilesRequest.Builder> implements ListProfilesRequestOrBuilder

List profiles request.

Protobuf type google.cloud.talent.v4beta1.ListProfilesRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListProfilesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListProfilesRequest.Builder
Overrides

build()

public ListProfilesRequest build()
Returns
TypeDescription
ListProfilesRequest

buildPartial()

public ListProfilesRequest buildPartial()
Returns
TypeDescription
ListProfilesRequest

clear()

public ListProfilesRequest.Builder clear()
Returns
TypeDescription
ListProfilesRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListProfilesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListProfilesRequest.Builder
Overrides

clearFilter()

public ListProfilesRequest.Builder clearFilter()

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"

string filter = 5;

Returns
TypeDescription
ListProfilesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListProfilesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListProfilesRequest.Builder
Overrides

clearPageSize()

public ListProfilesRequest.Builder clearPageSize()

The maximum number of profiles to be returned, at most 100. Default is 100 unless a positive number smaller than 100 is specified.

int32 page_size = 3;

Returns
TypeDescription
ListProfilesRequest.Builder

This builder for chaining.

clearPageToken()

public ListProfilesRequest.Builder clearPageToken()

The token that specifies the current offset (that is, starting result). Please set the value to ListProfilesResponse.next_page_token to continue the list.

string page_token = 2;

Returns
TypeDescription
ListProfilesRequest.Builder

This builder for chaining.

clearParent()

public ListProfilesRequest.Builder clearParent()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ListProfilesRequest.Builder

This builder for chaining.

clearReadMask()

public ListProfilesRequest.Builder clearReadMask()

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

.google.protobuf.FieldMask read_mask = 4;

Returns
TypeDescription
ListProfilesRequest.Builder

clone()

public ListProfilesRequest.Builder clone()
Returns
TypeDescription
ListProfilesRequest.Builder
Overrides

getDefaultInstanceForType()

public ListProfilesRequest getDefaultInstanceForType()
Returns
TypeDescription
ListProfilesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFilter()

public String getFilter()

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"

string filter = 5;

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

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"

string filter = 5;

Returns
TypeDescription
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

The maximum number of profiles to be returned, at most 100. Default is 100 unless a positive number smaller than 100 is specified.

int32 page_size = 3;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

The token that specifies the current offset (that is, starting result). Please set the value to ListProfilesResponse.next_page_token to continue the list.

string page_token = 2;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

The token that specifies the current offset (that is, starting result). Please set the value to ListProfilesResponse.next_page_token to continue the list.

string page_token = 2;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public String getParent()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for parent.

getReadMask()

public FieldMask getReadMask()

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

.google.protobuf.FieldMask read_mask = 4;

Returns
TypeDescription
FieldMask

The readMask.

getReadMaskBuilder()

public FieldMask.Builder getReadMaskBuilder()

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

.google.protobuf.FieldMask read_mask = 4;

Returns
TypeDescription
Builder

getReadMaskOrBuilder()

public FieldMaskOrBuilder getReadMaskOrBuilder()

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

.google.protobuf.FieldMask read_mask = 4;

Returns
TypeDescription
FieldMaskOrBuilder

hasReadMask()

public boolean hasReadMask()

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

.google.protobuf.FieldMask read_mask = 4;

Returns
TypeDescription
boolean

Whether the readMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListProfilesRequest other)

public ListProfilesRequest.Builder mergeFrom(ListProfilesRequest other)
Parameter
NameDescription
otherListProfilesRequest
Returns
TypeDescription
ListProfilesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListProfilesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListProfilesRequest.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListProfilesRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListProfilesRequest.Builder
Overrides

mergeReadMask(FieldMask value)

public ListProfilesRequest.Builder mergeReadMask(FieldMask value)

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

.google.protobuf.FieldMask read_mask = 4;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
ListProfilesRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListProfilesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListProfilesRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListProfilesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListProfilesRequest.Builder
Overrides

setFilter(String value)

public ListProfilesRequest.Builder setFilter(String value)

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"

string filter = 5;

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
ListProfilesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListProfilesRequest.Builder setFilterBytes(ByteString value)

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"

string filter = 5;

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
ListProfilesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListProfilesRequest.Builder setPageSize(int value)

The maximum number of profiles to be returned, at most 100. Default is 100 unless a positive number smaller than 100 is specified.

int32 page_size = 3;

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListProfilesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListProfilesRequest.Builder setPageToken(String value)

The token that specifies the current offset (that is, starting result). Please set the value to ListProfilesResponse.next_page_token to continue the list.

string page_token = 2;

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListProfilesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListProfilesRequest.Builder setPageTokenBytes(ByteString value)

The token that specifies the current offset (that is, starting result). Please set the value to ListProfilesResponse.next_page_token to continue the list.

string page_token = 2;

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListProfilesRequest.Builder

This builder for chaining.

setParent(String value)

public ListProfilesRequest.Builder setParent(String value)

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
ListProfilesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListProfilesRequest.Builder setParentBytes(ByteString value)

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
ListProfilesRequest.Builder

This builder for chaining.

setReadMask(FieldMask value)

public ListProfilesRequest.Builder setReadMask(FieldMask value)

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

.google.protobuf.FieldMask read_mask = 4;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
ListProfilesRequest.Builder

setReadMask(FieldMask.Builder builderForValue)

public ListProfilesRequest.Builder setReadMask(FieldMask.Builder builderForValue)

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

.google.protobuf.FieldMask read_mask = 4;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ListProfilesRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListProfilesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListProfilesRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListProfilesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListProfilesRequest.Builder
Overrides