- 1.50.0 (latest)
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.2
- 1.0.1
- 0.2.2
public static final class ListSessionsRequest.Builder extends GeneratedMessageV3.Builder<ListSessionsRequest.Builder> implements ListSessionsRequestOrBuilder
List sessions request.
Protobuf type google.cloud.dataplex.v1.ListSessionsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListSessionsRequest.BuilderImplements
ListSessionsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListSessionsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
ListSessionsRequest.Builder |
build()
public ListSessionsRequest build()
Returns | |
---|---|
Type | Description |
ListSessionsRequest |
buildPartial()
public ListSessionsRequest buildPartial()
Returns | |
---|---|
Type | Description |
ListSessionsRequest |
clear()
public ListSessionsRequest.Builder clear()
Returns | |
---|---|
Type | Description |
ListSessionsRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public ListSessionsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
ListSessionsRequest.Builder |
clearFilter()
public ListSessionsRequest.Builder clearFilter()
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];
Returns | |
---|---|
Type | Description |
ListSessionsRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListSessionsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
ListSessionsRequest.Builder |
clearPageSize()
public ListSessionsRequest.Builder clearPageSize()
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];
Returns | |
---|---|
Type | Description |
ListSessionsRequest.Builder | This builder for chaining. |
clearPageToken()
public ListSessionsRequest.Builder clearPageToken()
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];
Returns | |
---|---|
Type | Description |
ListSessionsRequest.Builder | This builder for chaining. |
clearParent()
public ListSessionsRequest.Builder clearParent()
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) = { ... }
Returns | |
---|---|
Type | Description |
ListSessionsRequest.Builder | This builder for chaining. |
clone()
public ListSessionsRequest.Builder clone()
Returns | |
---|---|
Type | Description |
ListSessionsRequest.Builder |
getDefaultInstanceForType()
public ListSessionsRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
ListSessionsRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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];
Returns | |
---|---|
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];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for filter. |
getPageSize()
public int 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];
Returns | |
---|---|
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];
Returns | |
---|---|
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];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for pageToken. |
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) = { ... }
Returns | |
---|---|
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) = { ... }
Returns | |
---|---|
Type | Description |
ByteString | The bytes for parent. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(ListSessionsRequest other)
public ListSessionsRequest.Builder mergeFrom(ListSessionsRequest other)
Parameter | |
---|---|
Name | Description |
other | ListSessionsRequest |
Returns | |
---|---|
Type | Description |
ListSessionsRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListSessionsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ListSessionsRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public ListSessionsRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
ListSessionsRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListSessionsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListSessionsRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public ListSessionsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
ListSessionsRequest.Builder |
setFilter(String value)
public ListSessionsRequest.Builder setFilter(String value)
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];
Parameter | |
---|---|
Name | Description |
value | String The filter to set. |
Returns | |
---|---|
Type | Description |
ListSessionsRequest.Builder | This builder for chaining. |
setFilterBytes(ByteString value)
public ListSessionsRequest.Builder setFilterBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for filter to set. |
Returns | |
---|---|
Type | Description |
ListSessionsRequest.Builder | This builder for chaining. |
setPageSize(int value)
public ListSessionsRequest.Builder setPageSize(int value)
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];
Parameter | |
---|---|
Name | Description |
value | int The pageSize to set. |
Returns | |
---|---|
Type | Description |
ListSessionsRequest.Builder | This builder for chaining. |
setPageToken(String value)
public ListSessionsRequest.Builder setPageToken(String value)
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];
Parameter | |
---|---|
Name | Description |
value | String The pageToken to set. |
Returns | |
---|---|
Type | Description |
ListSessionsRequest.Builder | This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListSessionsRequest.Builder setPageTokenBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for pageToken to set. |
Returns | |
---|---|
Type | Description |
ListSessionsRequest.Builder | This builder for chaining. |
setParent(String value)
public ListSessionsRequest.Builder setParent(String value)
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) = { ... }
Parameter | |
---|---|
Name | Description |
value | String The parent to set. |
Returns | |
---|---|
Type | Description |
ListSessionsRequest.Builder | This builder for chaining. |
setParentBytes(ByteString value)
public ListSessionsRequest.Builder setParentBytes(ByteString value)
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) = { ... }
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for parent to set. |
Returns | |
---|---|
Type | Description |
ListSessionsRequest.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListSessionsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
ListSessionsRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListSessionsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListSessionsRequest.Builder |