public sealed class ListSessionsRequest : IPageRequest, IMessage<ListSessionsRequest>, IEquatable<ListSessionsRequest>, IDeepCloneable<ListSessionsRequest>, IBufferMessage, IMessage
Reference documentation and code samples for the Cloud Dataplex v1 API class ListSessionsRequest.
List sessions request.
Implements
IPageRequest, IMessageListSessionsRequest, IEquatableListSessionsRequest, IDeepCloneableListSessionsRequest, IBufferMessage, IMessageNamespace
Google.Cloud.Dataplex.V1Assembly
Google.Cloud.Dataplex.V1.dll
Constructors
ListSessionsRequest()
public ListSessionsRequest()
ListSessionsRequest(ListSessionsRequest)
public ListSessionsRequest(ListSessionsRequest other)
Parameter | |
---|---|
Name | Description |
other | ListSessionsRequest |
Properties
Filter
public string Filter { get; set; }
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
Property Value | |
---|---|
Type | Description |
string |
PageSize
public int PageSize { get; set; }
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.
Property Value | |
---|---|
Type | Description |
int |
PageToken
public string PageToken { get; set; }
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.
Property Value | |
---|---|
Type | Description |
string |
Parent
public string Parent { get; set; }
Required. The resource name of the parent environment:
projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
.
Property Value | |
---|---|
Type | Description |
string |
ParentAsEnvironmentName
public EnvironmentName ParentAsEnvironmentName { get; set; }
EnvironmentName-typed view over the Parent resource name property.
Property Value | |
---|---|
Type | Description |
EnvironmentName |