Package com.google.cloud.dataform.v1

Interface QueryDirectoryContentsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
QueryDirectoryContentsRequest, QueryDirectoryContentsRequest.Builder
@Generated public interface QueryDirectoryContentsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getPageSize()
    Optional.
    String
    getPageToken()
    Optional.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    Optional.
    String
    getPath()
    Optional.
    com.google.protobuf.ByteString
    getPathBytes()
    Optional.
    DirectoryContentsView
    getView()
    Optional.
    int
    getViewValue()
    Optional.
    String
    getWorkspace()
    Required.
    com.google.protobuf.ByteString
    getWorkspaceBytes()
    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 Details

    • getWorkspace

      String getWorkspace()
       Required. The workspace's name.
      string workspace = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The workspace.

    • getWorkspaceBytes

      com.google.protobuf.ByteString getWorkspaceBytes()
       Required. The workspace's name.
      string workspace = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for workspace.

    • getPath

      String getPath()
       Optional. The directory's full path including directory name, relative to
 the workspace root. If left unset, the workspace root is used.
      string path = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The path.

    • getPathBytes

      com.google.protobuf.ByteString getPathBytes()
       Optional. The directory's full path including directory name, relative to
 the workspace root. If left unset, the workspace root is used.
      string path = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for path.

    • getPageSize

      int getPageSize()
       Optional. Maximum number of paths to return. The server may return fewer
 items than requested. If unspecified, the server will pick an appropriate
 default.
      int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pageSize.

    • getPageToken

      String getPageToken()
       Optional. Page token received from a previous `QueryDirectoryContents`
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 `QueryDirectoryContents`, with the exception of `page_size`, must match the
 call that provided the page token.
      string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       Optional. Page token received from a previous `QueryDirectoryContents`
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 `QueryDirectoryContents`, with the exception of `page_size`, must match the
 call that provided the page token.
      string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for pageToken.

    • getViewValue

      int getViewValue()
       Optional. Specifies the metadata to return for each directory entry.
 If unspecified, the default is `DIRECTORY_CONTENTS_VIEW_BASIC`.
 Currently the `DIRECTORY_CONTENTS_VIEW_METADATA` view is not supported by
 CMEK-protected workspaces.
      .google.cloud.dataform.v1.DirectoryContentsView view = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for view.

    • getView

      DirectoryContentsView getView()
       Optional. Specifies the metadata to return for each directory entry.
 If unspecified, the default is `DIRECTORY_CONTENTS_VIEW_BASIC`.
 Currently the `DIRECTORY_CONTENTS_VIEW_METADATA` view is not supported by
 CMEK-protected workspaces.
      .google.cloud.dataform.v1.DirectoryContentsView view = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The view.