Class ListWorkspacesRequest

  • All Implemented Interfaces:
    ListWorkspacesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class ListWorkspacesRequest
    extends com.google.protobuf.GeneratedMessageV3
    implements ListWorkspacesRequestOrBuilder
     `ListWorkspaces` request message.
     
    Protobuf type google.cloud.dataform.v1alpha2.ListWorkspacesRequest
    See Also:
    Serialized Form
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • getParent

        public String getParent()
         Required. The repository in which to list workspaces. Must be in the
         format `projects/*/locations/*/repositories/*`.
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParent in interface ListWorkspacesRequestOrBuilder
        Returns:
        The parent.
      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         Required. The repository in which to list workspaces. Must be in the
         format `projects/*/locations/*/repositories/*`.
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParentBytes in interface ListWorkspacesRequestOrBuilder
        Returns:
        The bytes for parent.
      • getPageSize

        public int getPageSize()
         Optional. Maximum number of workspaces to return. The server may return fewer
         items than requested. If unspecified, the server will pick an appropriate
         default.
         
        int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageSize in interface ListWorkspacesRequestOrBuilder
        Returns:
        The pageSize.
      • getPageToken

        public String getPageToken()
         Optional. Page token received from a previous `ListWorkspaces` call.
         Provide this to retrieve the subsequent page.
        
         When paginating, all other parameters provided to `ListWorkspaces`
         must match the call that provided the page token.
         
        string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageToken in interface ListWorkspacesRequestOrBuilder
        Returns:
        The pageToken.
      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         Optional. Page token received from a previous `ListWorkspaces` call.
         Provide this to retrieve the subsequent page.
        
         When paginating, all other parameters provided to `ListWorkspaces`
         must match the call that provided the page token.
         
        string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageTokenBytes in interface ListWorkspacesRequestOrBuilder
        Returns:
        The bytes for pageToken.
      • getOrderBy

        public String getOrderBy()
         Optional. This field only supports ordering by `name`. If unspecified, the server
         will choose the ordering. If specified, the default order is ascending for
         the `name` field.
         
        string order_by = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getOrderBy in interface ListWorkspacesRequestOrBuilder
        Returns:
        The orderBy.
      • getOrderByBytes

        public com.google.protobuf.ByteString getOrderByBytes()
         Optional. This field only supports ordering by `name`. If unspecified, the server
         will choose the ordering. If specified, the default order is ascending for
         the `name` field.
         
        string order_by = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getOrderByBytes in interface ListWorkspacesRequestOrBuilder
        Returns:
        The bytes for orderBy.
      • getFilter

        public String getFilter()
         Optional. Filter for the returned list.
         
        string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFilter in interface ListWorkspacesRequestOrBuilder
        Returns:
        The filter.
      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         Optional. Filter for the returned list.
         
        string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFilterBytes in interface ListWorkspacesRequestOrBuilder
        Returns:
        The bytes for filter.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • 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.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • 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 ListWorkspacesRequest parseFrom​(ByteBuffer data)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

        protected ListWorkspacesRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<ListWorkspacesRequest> 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.GeneratedMessageV3
      • getDefaultInstanceForType

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