public final class ListSessionsRequest extends GeneratedMessageV3 implements ListSessionsRequestOrBuilder
List sessions request.
Protobuf type google.cloud.dataplex.v1.ListSessionsRequest
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_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
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ListSessionsRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ListSessionsRequest.Builder newBuilder()
Returns
newBuilder(ListSessionsRequest prototype)
public static ListSessionsRequest.Builder newBuilder(ListSessionsRequest prototype)
Parameter
Returns
public static ListSessionsRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListSessionsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ListSessionsRequest parseFrom(byte[] data)
Parameter
| Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListSessionsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ListSessionsRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListSessionsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListSessionsRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ListSessionsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListSessionsRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListSessionsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ListSessionsRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListSessionsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ListSessionsRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public ListSessionsRequest getDefaultInstanceForType()
Returns
getFilter()
public String getFilter()
Optional. Filter request. The following mode filter is supported to
return only the sessions belonging to the requester when the mode is USER
and return sessions of all the users when the mode is ADMIN. When no filter
is sent default to USER mode. NOTE: When the mode is ADMIN, the requester
should have dataplex.environments.listAllSessions permission to list all
sessions, in absence of the permission, the request fails.
mode = ADMIN | USER
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
String | The filter.
|
getFilterBytes()
public ByteString getFilterBytes()
Optional. Filter request. The following mode filter is supported to
return only the sessions belonging to the requester when the mode is USER
and return sessions of all the users when the mode is ADMIN. When no filter
is sent default to USER mode. NOTE: When the mode is ADMIN, the requester
should have dataplex.environments.listAllSessions permission to list all
sessions, in absence of the permission, the request fails.
mode = ADMIN | USER
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
getPageSize()
Optional. Maximum number of sessions to return. The service may return
fewer than this value. If unspecified, at most 10 sessions 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];
| Type | Description |
int | The pageSize.
|
getPageToken()
public String getPageToken()
Optional. Page token received from a previous ListSessions call. Provide
this to retrieve the subsequent page. When paginating, all other parameters
provided to ListSessions must match the call that provided the page
token.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
String | The pageToken.
|
getPageTokenBytes()
public ByteString getPageTokenBytes()
Optional. Page token received from a previous ListSessions call. Provide
this to retrieve the subsequent page. When paginating, all other parameters
provided to ListSessions must match the call that provided the page
token.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
getParent()
public String getParent()
Required. The resource name of the parent environment:
projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Type | Description |
String | The parent.
|
getParentBytes()
public ByteString getParentBytes()
Required. The resource name of the parent environment:
projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getParserForType()
public Parser<ListSessionsRequest> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ListSessionsRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListSessionsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ListSessionsRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
