Class ListWorkflowInvocationsRequest.Builder (0.82.0)

public static final class ListWorkflowInvocationsRequest.Builder extends GeneratedMessage.Builder<ListWorkflowInvocationsRequest.Builder> implements ListWorkflowInvocationsRequestOrBuilder

ListWorkflowInvocations request message.

Protobuf type google.cloud.dataform.v1.ListWorkflowInvocationsRequest

Static Methods

getDescriptor()

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

Methods

build()

public ListWorkflowInvocationsRequest build()
Returns
Type Description
ListWorkflowInvocationsRequest

buildPartial()

public ListWorkflowInvocationsRequest buildPartial()
Returns
Type Description
ListWorkflowInvocationsRequest

clear()

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

clearFilter()

public ListWorkflowInvocationsRequest.Builder clearFilter()

Optional. Filter for the returned list.

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

Returns
Type Description
ListWorkflowInvocationsRequest.Builder

This builder for chaining.

clearOrderBy()

public ListWorkflowInvocationsRequest.Builder clearOrderBy()

Optional. This field only supports ordering by name. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the name field.

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

Returns
Type Description
ListWorkflowInvocationsRequest.Builder

This builder for chaining.

clearPageSize()

public ListWorkflowInvocationsRequest.Builder clearPageSize()

Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

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

Returns
Type Description
ListWorkflowInvocationsRequest.Builder

This builder for chaining.

clearPageToken()

public ListWorkflowInvocationsRequest.Builder clearPageToken()

Optional. Page token received from a previous ListWorkflowInvocations call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListWorkflowInvocations, with the exception of page_size, must match the call that provided the page token.

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

Returns
Type Description
ListWorkflowInvocationsRequest.Builder

This builder for chaining.

clearParent()

public ListWorkflowInvocationsRequest.Builder clearParent()

Required. The parent resource of the WorkflowInvocation type. Must be in the format projects/*/locations/*/repositories/*.

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

Returns
Type Description
ListWorkflowInvocationsRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ListWorkflowInvocationsRequest getDefaultInstanceForType()
Returns
Type Description
ListWorkflowInvocationsRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Optional. Filter for the returned list.

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

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. Filter for the returned list.

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

Returns
Type Description
ByteString

The bytes for filter.

getOrderBy()

public String getOrderBy()

Optional. This field only supports ordering by name. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the name field.

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

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Optional. This field only supports ordering by name. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the name field.

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

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

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

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. Page token received from a previous ListWorkflowInvocations call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListWorkflowInvocations, with the exception of page_size, 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. Page token received from a previous ListWorkflowInvocations call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListWorkflowInvocations, with the exception of page_size, 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 resource of the WorkflowInvocation type. Must be in the format projects/*/locations/*/repositories/*.

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 resource of the WorkflowInvocation type. Must be in the format projects/*/locations/*/repositories/*.

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

Returns
Type Description
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListWorkflowInvocationsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setFilter(String value)

public ListWorkflowInvocationsRequest.Builder setFilter(String value)

Optional. Filter for the returned list.

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

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListWorkflowInvocationsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListWorkflowInvocationsRequest.Builder setFilterBytes(ByteString value)

Optional. Filter for the returned list.

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

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListWorkflowInvocationsRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListWorkflowInvocationsRequest.Builder setOrderBy(String value)

Optional. This field only supports ordering by name. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the name field.

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

Parameter
Name Description
value String

The orderBy to set.

Returns
Type Description
ListWorkflowInvocationsRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListWorkflowInvocationsRequest.Builder setOrderByBytes(ByteString value)

Optional. This field only supports ordering by name. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the name field.

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

Parameter
Name Description
value ByteString

The bytes for orderBy to set.

Returns
Type Description
ListWorkflowInvocationsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListWorkflowInvocationsRequest.Builder setPageSize(int value)

Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

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

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListWorkflowInvocationsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListWorkflowInvocationsRequest.Builder setPageToken(String value)

Optional. Page token received from a previous ListWorkflowInvocations call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListWorkflowInvocations, with the exception of page_size, 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
ListWorkflowInvocationsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListWorkflowInvocationsRequest.Builder setPageTokenBytes(ByteString value)

Optional. Page token received from a previous ListWorkflowInvocations call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListWorkflowInvocations, with the exception of page_size, 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
ListWorkflowInvocationsRequest.Builder

This builder for chaining.

setParent(String value)

public ListWorkflowInvocationsRequest.Builder setParent(String value)

Required. The parent resource of the WorkflowInvocation type. Must be in the format projects/*/locations/*/repositories/*.

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListWorkflowInvocationsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListWorkflowInvocationsRequest.Builder setParentBytes(ByteString value)

Required. The parent resource of the WorkflowInvocation type. Must be in the format projects/*/locations/*/repositories/*.

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

This builder for chaining.