Package com.google.cloud.clouddms.v1

Class DescribeDatabaseEntitiesRequest.Builder

    • Method Detail

      • 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.Builder<DescribeDatabaseEntitiesRequest.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<DescribeDatabaseEntitiesRequest.Builder>

      • getDefaultInstanceForType

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

      • build

        public DescribeDatabaseEntitiesRequest build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public DescribeDatabaseEntitiesRequest buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<DescribeDatabaseEntitiesRequest.Builder>

      • getConversionWorkspace

        public String getConversionWorkspace()
         Required. Name of the conversion workspace resource whose database entities
 are described. Must be in the form of:
 projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
        string conversion_workspace = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getConversionWorkspace in interface DescribeDatabaseEntitiesRequestOrBuilder
        Returns:
        The conversionWorkspace.

      • getConversionWorkspaceBytes

        public com.google.protobuf.ByteString getConversionWorkspaceBytes()
         Required. Name of the conversion workspace resource whose database entities
 are described. Must be in the form of:
 projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
        string conversion_workspace = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getConversionWorkspaceBytes in interface DescribeDatabaseEntitiesRequestOrBuilder
        Returns:
        The bytes for conversionWorkspace.

      • setConversionWorkspace

        public DescribeDatabaseEntitiesRequest.Builder setConversionWorkspace​(String value)
         Required. Name of the conversion workspace resource whose database entities
 are described. Must be in the form of:
 projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
        string conversion_workspace = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The conversionWorkspace to set.
        Returns:
        This builder for chaining.

      • clearConversionWorkspace

        public DescribeDatabaseEntitiesRequest.Builder clearConversionWorkspace()
         Required. Name of the conversion workspace resource whose database entities
 are described. Must be in the form of:
 projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
        string conversion_workspace = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • setConversionWorkspaceBytes

        public DescribeDatabaseEntitiesRequest.Builder setConversionWorkspaceBytes​(com.google.protobuf.ByteString value)
         Required. Name of the conversion workspace resource whose database entities
 are described. Must be in the form of:
 projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
        string conversion_workspace = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for conversionWorkspace to set.
        Returns:
        This builder for chaining.

      • getPageSize

        public int getPageSize()
         Optional. The maximum number of entities to return. The service may return
 fewer entities than the value specifies.
        int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageSize in interface DescribeDatabaseEntitiesRequestOrBuilder
        Returns:
        The pageSize.

      • setPageSize

        public DescribeDatabaseEntitiesRequest.Builder setPageSize​(int value)
         Optional. The maximum number of entities to return. The service may return
 fewer entities than the value specifies.
        int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The pageSize to set.
        Returns:
        This builder for chaining.

      • clearPageSize

        public DescribeDatabaseEntitiesRequest.Builder clearPageSize()
         Optional. The maximum number of entities to return. The service may return
 fewer entities than the value specifies.
        int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • getPageToken

        public String getPageToken()
         Optional. The nextPageToken value received in the previous call to
 conversionWorkspace.describeDatabaseEntities, used in the subsequent
 request to retrieve the next page of results. On first call this should be
 left blank. When paginating, all other parameters provided to
 conversionWorkspace.describeDatabaseEntities must match the call that
 provided the page token.
        string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageToken in interface DescribeDatabaseEntitiesRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         Optional. The nextPageToken value received in the previous call to
 conversionWorkspace.describeDatabaseEntities, used in the subsequent
 request to retrieve the next page of results. On first call this should be
 left blank. When paginating, all other parameters provided to
 conversionWorkspace.describeDatabaseEntities must match the call that
 provided the page token.
        string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageTokenBytes in interface DescribeDatabaseEntitiesRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • setPageToken

        public DescribeDatabaseEntitiesRequest.Builder setPageToken​(String value)
         Optional. The nextPageToken value received in the previous call to
 conversionWorkspace.describeDatabaseEntities, used in the subsequent
 request to retrieve the next page of results. On first call this should be
 left blank. When paginating, all other parameters provided to
 conversionWorkspace.describeDatabaseEntities must match the call that
 provided the page token.
        string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The pageToken to set.
        Returns:
        This builder for chaining.

      • clearPageToken

        public DescribeDatabaseEntitiesRequest.Builder clearPageToken()
         Optional. The nextPageToken value received in the previous call to
 conversionWorkspace.describeDatabaseEntities, used in the subsequent
 request to retrieve the next page of results. On first call this should be
 left blank. When paginating, all other parameters provided to
 conversionWorkspace.describeDatabaseEntities must match the call that
 provided the page token.
        string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • setPageTokenBytes

        public DescribeDatabaseEntitiesRequest.Builder setPageTokenBytes​(com.google.protobuf.ByteString value)
         Optional. The nextPageToken value received in the previous call to
 conversionWorkspace.describeDatabaseEntities, used in the subsequent
 request to retrieve the next page of results. On first call this should be
 left blank. When paginating, all other parameters provided to
 conversionWorkspace.describeDatabaseEntities must match the call that
 provided the page token.
        string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes for pageToken to set.
        Returns:
        This builder for chaining.

      • getTreeValue

        public int getTreeValue()
         Required. The tree to fetch.
        .google.cloud.clouddms.v1.DescribeDatabaseEntitiesRequest.DBTreeType tree = 6 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTreeValue in interface DescribeDatabaseEntitiesRequestOrBuilder
        Returns:
        The enum numeric value on the wire for tree.

      • setTreeValue

        public DescribeDatabaseEntitiesRequest.Builder setTreeValue​(int value)
         Required. The tree to fetch.
        .google.cloud.clouddms.v1.DescribeDatabaseEntitiesRequest.DBTreeType tree = 6 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The enum numeric value on the wire for tree to set.
        Returns:
        This builder for chaining.

      • clearTree

        public DescribeDatabaseEntitiesRequest.Builder clearTree()
         Required. The tree to fetch.
        .google.cloud.clouddms.v1.DescribeDatabaseEntitiesRequest.DBTreeType tree = 6 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • getUncommitted

        public boolean getUncommitted()
         Optional. Whether to retrieve the latest committed version of the entities
 or the latest version. This field is ignored if a specific commit_id is
 specified.
        bool uncommitted = 11 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getUncommitted in interface DescribeDatabaseEntitiesRequestOrBuilder
        Returns:
        The uncommitted.

      • setUncommitted

        public DescribeDatabaseEntitiesRequest.Builder setUncommitted​(boolean value)
         Optional. Whether to retrieve the latest committed version of the entities
 or the latest version. This field is ignored if a specific commit_id is
 specified.
        bool uncommitted = 11 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The uncommitted to set.
        Returns:
        This builder for chaining.

      • clearUncommitted

        public DescribeDatabaseEntitiesRequest.Builder clearUncommitted()
         Optional. Whether to retrieve the latest committed version of the entities
 or the latest version. This field is ignored if a specific commit_id is
 specified.
        bool uncommitted = 11 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • getCommitId

        public String getCommitId()
         Optional. Request a specific commit ID. If not specified, the entities from
 the latest commit are returned.
        string commit_id = 12 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getCommitId in interface DescribeDatabaseEntitiesRequestOrBuilder
        Returns:
        The commitId.

      • getCommitIdBytes

        public com.google.protobuf.ByteString getCommitIdBytes()
         Optional. Request a specific commit ID. If not specified, the entities from
 the latest commit are returned.
        string commit_id = 12 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getCommitIdBytes in interface DescribeDatabaseEntitiesRequestOrBuilder
        Returns:
        The bytes for commitId.

      • setCommitId

        public DescribeDatabaseEntitiesRequest.Builder setCommitId​(String value)
         Optional. Request a specific commit ID. If not specified, the entities from
 the latest commit are returned.
        string commit_id = 12 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The commitId to set.
        Returns:
        This builder for chaining.

      • clearCommitId

        public DescribeDatabaseEntitiesRequest.Builder clearCommitId()
         Optional. Request a specific commit ID. If not specified, the entities from
 the latest commit are returned.
        string commit_id = 12 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • setCommitIdBytes

        public DescribeDatabaseEntitiesRequest.Builder setCommitIdBytes​(com.google.protobuf.ByteString value)
         Optional. Request a specific commit ID. If not specified, the entities from
 the latest commit are returned.
        string commit_id = 12 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes for commitId to set.
        Returns:
        This builder for chaining.

      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         Optional. Filter the returned entities based on AIP-160 standard.
        string filter = 13 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFilterBytes in interface DescribeDatabaseEntitiesRequestOrBuilder
        Returns:
        The bytes for filter.

      • setFilter

        public DescribeDatabaseEntitiesRequest.Builder setFilter​(String value)
         Optional. Filter the returned entities based on AIP-160 standard.
        string filter = 13 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The filter to set.
        Returns:
        This builder for chaining.

      • clearFilter

        public DescribeDatabaseEntitiesRequest.Builder clearFilter()
         Optional. Filter the returned entities based on AIP-160 standard.
        string filter = 13 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • setFilterBytes

        public DescribeDatabaseEntitiesRequest.Builder setFilterBytes​(com.google.protobuf.ByteString value)
         Optional. Filter the returned entities based on AIP-160 standard.
        string filter = 13 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes for filter to set.
        Returns:
        This builder for chaining.

      • getViewValue

        public int getViewValue()
         Optional. Results view based on AIP-157
        .google.cloud.clouddms.v1.DatabaseEntityView view = 14 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getViewValue in interface DescribeDatabaseEntitiesRequestOrBuilder
        Returns:
        The enum numeric value on the wire for view.

      • setViewValue

        public DescribeDatabaseEntitiesRequest.Builder setViewValue​(int value)
         Optional. Results view based on AIP-157
        .google.cloud.clouddms.v1.DatabaseEntityView view = 14 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The enum numeric value on the wire for view to set.
        Returns:
        This builder for chaining.

      • setView

        public DescribeDatabaseEntitiesRequest.Builder setView​(DatabaseEntityView value)
         Optional. Results view based on AIP-157
        .google.cloud.clouddms.v1.DatabaseEntityView view = 14 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The view to set.
        Returns:
        This builder for chaining.

      • clearView

        public DescribeDatabaseEntitiesRequest.Builder clearView()
         Optional. Results view based on AIP-157
        .google.cloud.clouddms.v1.DatabaseEntityView view = 14 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.