public final class ListWorkspacesRequest extends GeneratedMessageV3 implements ListWorkspacesRequestOrBuilder
ListWorkspaces
request message.
Protobuf type google.cloud.dataform.v1alpha2.ListWorkspacesRequest
Static Fields
public static final int FILTER_FIELD_NUMBER
Field Value
public static final int ORDER_BY_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
public static final int PARENT_FIELD_NUMBER
Field Value
Static Methods
public static ListWorkspacesRequest getDefaultInstance()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public static ListWorkspacesRequest.Builder newBuilder()
Returns
public static ListWorkspacesRequest.Builder newBuilder(ListWorkspacesRequest prototype)
Parameter
Returns
public static ListWorkspacesRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListWorkspacesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListWorkspacesRequest parseFrom(byte[] data)
Parameter
Name |
Description |
data |
byte[]
|
Returns
Exceptions
public static ListWorkspacesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListWorkspacesRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static ListWorkspacesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListWorkspacesRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ListWorkspacesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListWorkspacesRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListWorkspacesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListWorkspacesRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static ListWorkspacesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<ListWorkspacesRequest> parser()
Returns
Methods
public boolean equals(Object obj)
Parameter
Returns
Overrides
public ListWorkspacesRequest getDefaultInstanceForType()
Returns
public String getFilter()
Optional. Filter for the returned list.
string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type |
Description |
String |
The filter.
|
public ByteString getFilterBytes()
Optional. Filter for the returned list.
string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns
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.
|
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()
Optional. Maximum number of workspaces 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 ListWorkspaces
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListWorkspaces
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 ListWorkspaces
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListWorkspaces
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.
|
public String getParent()
Required. The repository in which to list workspaces. 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.
|
public ByteString getParentBytes()
Required. The repository in which to list workspaces. Must be in the
format projects/*/locations/*/repositories/*
.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns
public Parser<ListWorkspacesRequest> getParserForType()
Returns
Overrides
public int getSerializedSize()
Returns
Overrides
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public ListWorkspacesRequest.Builder newBuilderForType()
Returns
protected ListWorkspacesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public ListWorkspacesRequest.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions