public final class ListProfilesRequest extends GeneratedMessageV3 implements ListProfilesRequestOrBuilder
List profiles request.
Protobuf type google.cloud.talent.v4beta1.ListProfilesRequest
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
READ_MASK_FIELD_NUMBER
public static final int READ_MASK_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ListProfilesRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ListProfilesRequest.Builder newBuilder()
Returns
newBuilder(ListProfilesRequest prototype)
public static ListProfilesRequest.Builder newBuilder(ListProfilesRequest prototype)
Parameter
Returns
public static ListProfilesRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListProfilesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ListProfilesRequest parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListProfilesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ListProfilesRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListProfilesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListProfilesRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ListProfilesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListProfilesRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListProfilesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ListProfilesRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListProfilesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ListProfilesRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public ListProfilesRequest getDefaultInstanceForType()
Returns
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
Type | Description |
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
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
Type | Description |
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
Type | Description |
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
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
Type | Description |
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
getParserForType()
public Parser<ListProfilesRequest> getParserForType()
Returns
Overrides
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:
.google.protobuf.FieldMask read_mask = 4;
Returns
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:
.google.protobuf.FieldMask read_mask = 4;
Returns
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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:
.google.protobuf.FieldMask read_mask = 4;
Returns
Type | Description |
boolean | Whether the readMask field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ListProfilesRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListProfilesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ListProfilesRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions