Class ListSynonymSetsRequest (0.42.0)

public final class ListSynonymSetsRequest extends GeneratedMessageV3 implements ListSynonymSetsRequestOrBuilder

Request message for SynonymSetService.ListSynonymSets. Will return all synonymSets belonging to the customer project.

Protobuf type google.cloud.contentwarehouse.v1.ListSynonymSetsRequest

Static Fields

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListSynonymSetsRequest getDefaultInstance()
Returns
Type Description
ListSynonymSetsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ListSynonymSetsRequest.Builder newBuilder()
Returns
Type Description
ListSynonymSetsRequest.Builder

newBuilder(ListSynonymSetsRequest prototype)

public static ListSynonymSetsRequest.Builder newBuilder(ListSynonymSetsRequest prototype)
Parameter
Name Description
prototype ListSynonymSetsRequest
Returns
Type Description
ListSynonymSetsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListSynonymSetsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListSynonymSetsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListSynonymSetsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSynonymSetsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListSynonymSetsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListSynonymSetsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListSynonymSetsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSynonymSetsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListSynonymSetsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListSynonymSetsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListSynonymSetsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSynonymSetsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListSynonymSetsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListSynonymSetsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListSynonymSetsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSynonymSetsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListSynonymSetsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListSynonymSetsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListSynonymSetsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSynonymSetsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListSynonymSetsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListSynonymSetsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListSynonymSetsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSynonymSetsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListSynonymSetsRequest> parser()
Returns
Type Description
Parser<ListSynonymSetsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ListSynonymSetsRequest getDefaultInstanceForType()
Returns
Type Description
ListSynonymSetsRequest

getPageSize()

public int getPageSize()

The maximum number of synonymSets to return. The service may return fewer than this value. If unspecified, at most 50 rule sets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

int32 page_size = 2;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

A page token, received from a previous ListSynonymSets call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListSynonymSets must match the call that provided the page token.

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

A page token, received from a previous ListSynonymSets call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListSynonymSets must match the call that provided the page token.

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The parent name. Format: projects/{project_number}/locations/{location}.

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent name. Format: projects/{project_number}/locations/{location}.

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

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<ListSynonymSetsRequest> getParserForType()
Returns
Type Description
Parser<ListSynonymSetsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListSynonymSetsRequest.Builder newBuilderForType()
Returns
Type Description
ListSynonymSetsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListSynonymSetsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListSynonymSetsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ListSynonymSetsRequest.Builder toBuilder()
Returns
Type Description
ListSynonymSetsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException