Class ListWorkflowsRequest.Builder (2.54.0) 

public static final class ListWorkflowsRequest.Builder extends GeneratedMessageV3.Builder<ListWorkflowsRequest.Builder> implements ListWorkflowsRequestOrBuilder

Request for the ListWorkflows method.

Protobuf type google.cloud.workflows.v1beta.ListWorkflowsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListWorkflowsRequest.Builder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListWorkflowsRequest build()
Returns
Type Description
ListWorkflowsRequest

buildPartial()

public ListWorkflowsRequest buildPartial()
Returns
Type Description
ListWorkflowsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListWorkflowsRequest.Builder clearFilter()

Filter to restrict results to specific workflows.

string filter = 4;

Returns
Type Description
ListWorkflowsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOrderBy()

public ListWorkflowsRequest.Builder clearOrderBy()

Comma-separated list of fields that that specify the order of the results. Default sorting order for a field is ascending. To specify descending order for a field, append a " desc" suffix. If not specified, the results will be returned in an unspecified order.

string order_by = 5;

Returns
Type Description
ListWorkflowsRequest.Builder

This builder for chaining.

clearPageSize()

public ListWorkflowsRequest.Builder clearPageSize()

Maximum number of workflows to return per call. The service may return fewer than this value. If the value is not specified, a default value of 500 will be used. The maximum permitted value is 1000 and values greater than 1000 will be coerced down to 1000.

int32 page_size = 2;

Returns
Type Description
ListWorkflowsRequest.Builder

This builder for chaining.

clearPageToken()

public ListWorkflowsRequest.Builder clearPageToken()

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

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

string page_token = 3;

Returns
Type Description
ListWorkflowsRequest.Builder

This builder for chaining.

clearParent()

public ListWorkflowsRequest.Builder clearParent()

Required. Project and location from which the workflows should be listed. Format: projects/{project}/locations/{location}

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

Returns
Type Description
ListWorkflowsRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListWorkflowsRequest getDefaultInstanceForType()
Returns
Type Description
ListWorkflowsRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Filter to restrict results to specific workflows.

string filter = 4;

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Filter to restrict results to specific workflows.

string filter = 4;

Returns
Type Description
ByteString

The bytes for filter.

getOrderBy()

public String getOrderBy()

Comma-separated list of fields that that specify the order of the results. Default sorting order for a field is ascending. To specify descending order for a field, append a " desc" suffix. If not specified, the results will be returned in an unspecified order.

string order_by = 5;

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Comma-separated list of fields that that specify the order of the results. Default sorting order for a field is ascending. To specify descending order for a field, append a " desc" suffix. If not specified, the results will be returned in an unspecified order.

string order_by = 5;

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

Maximum number of workflows to return per call. The service may return fewer than this value. If the value is not specified, a default value of 500 will be used. The maximum permitted value is 1000 and values greater than 1000 will be coerced down to 1000.

int32 page_size = 2;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

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

When paginating, all other parameters provided to ListWorkflows 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 ListWorkflows call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListWorkflows 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. Project and location from which the workflows should be listed. Format: projects/{project}/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. Project and location from which the workflows should be listed. Format: projects/{project}/locations/{location}

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(ListWorkflowsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListWorkflowsRequest.Builder setFilter(String value)

Filter to restrict results to specific workflows.

string filter = 4;

Parameter
Name Description
value String

The filter to set.
Returns
Type Description
ListWorkflowsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListWorkflowsRequest.Builder setFilterBytes(ByteString value)

Filter to restrict results to specific workflows.

string filter = 4;

Parameter
Name Description
value ByteString

The bytes for filter to set.
Returns
Type Description
ListWorkflowsRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListWorkflowsRequest.Builder setOrderBy(String value)

Comma-separated list of fields that that specify the order of the results. Default sorting order for a field is ascending. To specify descending order for a field, append a " desc" suffix. If not specified, the results will be returned in an unspecified order.

string order_by = 5;

Parameter
Name Description
value String

The orderBy to set.
Returns
Type Description
ListWorkflowsRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListWorkflowsRequest.Builder setOrderByBytes(ByteString value)

Comma-separated list of fields that that specify the order of the results. Default sorting order for a field is ascending. To specify descending order for a field, append a " desc" suffix. If not specified, the results will be returned in an unspecified order.

string order_by = 5;

Parameter
Name Description
value ByteString

The bytes for orderBy to set.
Returns
Type Description
ListWorkflowsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListWorkflowsRequest.Builder setPageSize(int value)

Maximum number of workflows to return per call. The service may return fewer than this value. If the value is not specified, a default value of 500 will be used. The maximum permitted value is 1000 and values greater than 1000 will be coerced down to 1000.

int32 page_size = 2;

Parameter
Name Description
value int

The pageSize to set.
Returns
Type Description
ListWorkflowsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListWorkflowsRequest.Builder setPageToken(String value)

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

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

string page_token = 3;

Parameter
Name Description
value String

The pageToken to set.
Returns
Type Description
ListWorkflowsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListWorkflowsRequest.Builder setPageTokenBytes(ByteString value)

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

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

string page_token = 3;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.
Returns
Type Description
ListWorkflowsRequest.Builder

This builder for chaining.

setParent(String value)

public ListWorkflowsRequest.Builder setParent(String value)

Required. Project and location from which the workflows should be listed. Format: projects/{project}/locations/{location}

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

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
ListWorkflowsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListWorkflowsRequest.Builder setParentBytes(ByteString value)

Required. Project and location from which the workflows should be listed. Format: projects/{project}/locations/{location}

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
ListWorkflowsRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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