Class QueryDirectoryContentsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dataform.v1.QueryDirectoryContentsRequest
All Implemented Interfaces:
QueryDirectoryContentsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class QueryDirectoryContentsRequest extends com.google.protobuf.GeneratedMessage implements QueryDirectoryContentsRequestOrBuilder
 `QueryDirectoryContents` request message.
 
Protobuf type google.cloud.dataform.v1.QueryDirectoryContentsRequest
See Also:
  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • getWorkspace

      public String getWorkspace()
       Required. The workspace's name.
       
      string workspace = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getWorkspace in interface QueryDirectoryContentsRequestOrBuilder
      Returns:
      The workspace.
    • getWorkspaceBytes

      public com.google.protobuf.ByteString getWorkspaceBytes()
       Required. The workspace's name.
       
      string workspace = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getWorkspaceBytes in interface QueryDirectoryContentsRequestOrBuilder
      Returns:
      The bytes for workspace.
    • getPath

      public 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];
      Specified by:
      getPath in interface QueryDirectoryContentsRequestOrBuilder
      Returns:
      The path.
    • getPathBytes

      public 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];
      Specified by:
      getPathBytes in interface QueryDirectoryContentsRequestOrBuilder
      Returns:
      The bytes for path.
    • getPageSize

      public 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];
      Specified by:
      getPageSize in interface QueryDirectoryContentsRequestOrBuilder
      Returns:
      The pageSize.
    • getPageToken

      public 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];
      Specified by:
      getPageToken in interface QueryDirectoryContentsRequestOrBuilder
      Returns:
      The pageToken.
    • getPageTokenBytes

      public 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];
      Specified by:
      getPageTokenBytes in interface QueryDirectoryContentsRequestOrBuilder
      Returns:
      The bytes for pageToken.
    • getViewValue

      public 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];
      Specified by:
      getViewValue in interface QueryDirectoryContentsRequestOrBuilder
      Returns:
      The enum numeric value on the wire for view.
    • getView

      public 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];
      Specified by:
      getView in interface QueryDirectoryContentsRequestOrBuilder
      Returns:
      The view.
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static QueryDirectoryContentsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static QueryDirectoryContentsRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static QueryDirectoryContentsRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static QueryDirectoryContentsRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static QueryDirectoryContentsRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static QueryDirectoryContentsRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static QueryDirectoryContentsRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static QueryDirectoryContentsRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static QueryDirectoryContentsRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static QueryDirectoryContentsRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static QueryDirectoryContentsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static QueryDirectoryContentsRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public QueryDirectoryContentsRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static QueryDirectoryContentsRequest.Builder newBuilder()
    • newBuilder

    • toBuilder

      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected QueryDirectoryContentsRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static QueryDirectoryContentsRequest getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<QueryDirectoryContentsRequest> parser()
    • getParserForType

      public com.google.protobuf.Parser<QueryDirectoryContentsRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage
    • getDefaultInstanceForType

      public QueryDirectoryContentsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder