Class ListGlossaryCategoriesRequest.Builder (1.72.0)

public static final class ListGlossaryCategoriesRequest.Builder extends GeneratedMessageV3.Builder<ListGlossaryCategoriesRequest.Builder> implements ListGlossaryCategoriesRequestOrBuilder

List GlossaryCategories Request

Protobuf type google.cloud.dataplex.v1.ListGlossaryCategoriesRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListGlossaryCategoriesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListGlossaryCategoriesRequest.Builder
Overrides

build()

public ListGlossaryCategoriesRequest build()
Returns
Type Description
ListGlossaryCategoriesRequest

buildPartial()

public ListGlossaryCategoriesRequest buildPartial()
Returns
Type Description
ListGlossaryCategoriesRequest

clear()

public ListGlossaryCategoriesRequest.Builder clear()
Returns
Type Description
ListGlossaryCategoriesRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListGlossaryCategoriesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListGlossaryCategoriesRequest.Builder
Overrides

clearFilter()

public ListGlossaryCategoriesRequest.Builder clearFilter()

Optional. Filter expression that filters GlossaryCategories listed in the response. Filters are supported on the following fields:

  • immediate_parent

    Examples of using a filter are: - immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}" - immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}"

    This will only return the GlossaryCategories that are directly nested under the specified parent.

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListGlossaryCategoriesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListGlossaryCategoriesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListGlossaryCategoriesRequest.Builder
Overrides

clearOrderBy()

public ListGlossaryCategoriesRequest.Builder clearOrderBy()

Optional. Order by expression that orders GlossaryCategories listed in the response. Order by fields are: name or create_time for the result. If not specified, the ordering is undefined.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListGlossaryCategoriesRequest.Builder

This builder for chaining.

clearPageSize()

public ListGlossaryCategoriesRequest.Builder clearPageSize()

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

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListGlossaryCategoriesRequest.Builder

This builder for chaining.

clearPageToken()

public ListGlossaryCategoriesRequest.Builder clearPageToken()

Optional. A page token, received from a previous ListGlossaryCategories call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListGlossaryCategories must match the call that provided the page token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListGlossaryCategoriesRequest.Builder

This builder for chaining.

clearParent()

public ListGlossaryCategoriesRequest.Builder clearParent()

Required. The parent, which has this collection of GlossaryCategories. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} Location is the Google Cloud region.

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

Returns
Type Description
ListGlossaryCategoriesRequest.Builder

This builder for chaining.

clone()

public ListGlossaryCategoriesRequest.Builder clone()
Returns
Type Description
ListGlossaryCategoriesRequest.Builder
Overrides

getDefaultInstanceForType()

public ListGlossaryCategoriesRequest getDefaultInstanceForType()
Returns
Type Description
ListGlossaryCategoriesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFilter()

public String getFilter()

Optional. Filter expression that filters GlossaryCategories listed in the response. Filters are supported on the following fields:

  • immediate_parent

    Examples of using a filter are: - immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}" - immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}"

    This will only return the GlossaryCategories that are directly nested under the specified parent.

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. Filter expression that filters GlossaryCategories listed in the response. Filters are supported on the following fields:

  • immediate_parent

    Examples of using a filter are: - immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}" - immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}"

    This will only return the GlossaryCategories that are directly nested under the specified parent.

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for filter.

getOrderBy()

public String getOrderBy()

Optional. Order by expression that orders GlossaryCategories listed in the response. Order by fields are: name or create_time for the result. If not specified, the ordering is undefined.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Optional. Order by expression that orders GlossaryCategories listed in the response. Order by fields are: name or create_time for the result. If not specified, the ordering is undefined.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

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

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. A page token, received from a previous ListGlossaryCategories call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListGlossaryCategories must match the call that provided the page token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. A page token, received from a previous ListGlossaryCategories call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListGlossaryCategories must match the call that provided the page token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The parent, which has this collection of GlossaryCategories. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} Location is the Google Cloud region.

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, which has this collection of GlossaryCategories. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} Location is the Google Cloud region.

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

Returns
Type Description
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListGlossaryCategoriesRequest other)

public ListGlossaryCategoriesRequest.Builder mergeFrom(ListGlossaryCategoriesRequest other)
Parameter
Name Description
other ListGlossaryCategoriesRequest
Returns
Type Description
ListGlossaryCategoriesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListGlossaryCategoriesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListGlossaryCategoriesRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListGlossaryCategoriesRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListGlossaryCategoriesRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListGlossaryCategoriesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListGlossaryCategoriesRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListGlossaryCategoriesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListGlossaryCategoriesRequest.Builder
Overrides

setFilter(String value)

public ListGlossaryCategoriesRequest.Builder setFilter(String value)

Optional. Filter expression that filters GlossaryCategories listed in the response. Filters are supported on the following fields:

  • immediate_parent

    Examples of using a filter are: - immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}" - immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}"

    This will only return the GlossaryCategories that are directly nested under the specified parent.

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListGlossaryCategoriesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListGlossaryCategoriesRequest.Builder setFilterBytes(ByteString value)

Optional. Filter expression that filters GlossaryCategories listed in the response. Filters are supported on the following fields:

  • immediate_parent

    Examples of using a filter are: - immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}" - immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}"

    This will only return the GlossaryCategories that are directly nested under the specified parent.

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListGlossaryCategoriesRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListGlossaryCategoriesRequest.Builder setOrderBy(String value)

Optional. Order by expression that orders GlossaryCategories listed in the response. Order by fields are: name or create_time for the result. If not specified, the ordering is undefined.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The orderBy to set.

Returns
Type Description
ListGlossaryCategoriesRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListGlossaryCategoriesRequest.Builder setOrderByBytes(ByteString value)

Optional. Order by expression that orders GlossaryCategories listed in the response. Order by fields are: name or create_time for the result. If not specified, the ordering is undefined.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for orderBy to set.

Returns
Type Description
ListGlossaryCategoriesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListGlossaryCategoriesRequest.Builder setPageSize(int value)

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

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListGlossaryCategoriesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListGlossaryCategoriesRequest.Builder setPageToken(String value)

Optional. A page token, received from a previous ListGlossaryCategories call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListGlossaryCategories must match the call that provided the page token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListGlossaryCategoriesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListGlossaryCategoriesRequest.Builder setPageTokenBytes(ByteString value)

Optional. A page token, received from a previous ListGlossaryCategories call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListGlossaryCategories must match the call that provided the page token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListGlossaryCategoriesRequest.Builder

This builder for chaining.

setParent(String value)

public ListGlossaryCategoriesRequest.Builder setParent(String value)

Required. The parent, which has this collection of GlossaryCategories. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} Location is the Google Cloud region.

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListGlossaryCategoriesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListGlossaryCategoriesRequest.Builder setParentBytes(ByteString value)

Required. The parent, which has this collection of GlossaryCategories. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} Location is the Google Cloud region.

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

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListGlossaryCategoriesRequest.Builder

This builder for chaining.

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

public ListGlossaryCategoriesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListGlossaryCategoriesRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListGlossaryCategoriesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListGlossaryCategoriesRequest.Builder
Overrides