Interface ListSessionsRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ListSessionsRequest, ListSessionsRequest.Builder

    public interface ListSessionsRequestOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getFilter()
      Optional.
      com.google.protobuf.ByteString getFilterBytes()
      Optional.
      int getPageSize()
      Optional.
      String getPageToken()
      Optional.
      com.google.protobuf.ByteString getPageTokenBytes()
      Optional.
      String getParent()
      Required.
      com.google.protobuf.ByteString getParentBytes()
      Required.
      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized
      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
    • Method Detail

      • getParent

        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:
        The parent.
      • getParentBytes

        com.google.protobuf.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:
        The bytes for parent.
      • getPageSize

        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:
        The pageSize.
      • getPageToken

        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:
        The pageToken.
      • getPageTokenBytes

        com.google.protobuf.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:
        The bytes for pageToken.
      • getFilter

        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:
        The filter.
      • getFilterBytes

        com.google.protobuf.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:
        The bytes for filter.