Package com.google.cloud.discoveryengine.v1

Class PurgeDocumentsRequest.Builder

  • All Implemented Interfaces:
    PurgeDocumentsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    PurgeDocumentsRequest
    public static final class PurgeDocumentsRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsRequest.Builder>
implements PurgeDocumentsRequestOrBuilder
     Request message for
 [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1.DocumentService.PurgeDocuments]
 method.
    Protobuf type google.cloud.discoveryengine.v1.PurgeDocumentsRequest

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

      • clear

        public PurgeDocumentsRequest.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsRequest.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<PurgeDocumentsRequest.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public PurgeDocumentsRequest.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsRequest.Builder>

      • clearField

        public PurgeDocumentsRequest.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsRequest.Builder>

      • clearOneof

        public PurgeDocumentsRequest.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsRequest.Builder>

      • setRepeatedField

        public PurgeDocumentsRequest.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      int index,
                                                      Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsRequest.Builder>

      • addRepeatedField

        public PurgeDocumentsRequest.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsRequest.Builder>

      • isInitialized

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

      • mergeFrom

        public PurgeDocumentsRequest.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PurgeDocumentsRequest.Builder>
        Throws:
        IOException

      • getParent

        public String getParent()
         Required. The parent resource name, such as
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParent in interface PurgeDocumentsRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         Required. The parent resource name, such as
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParentBytes in interface PurgeDocumentsRequestOrBuilder
        Returns:
        The bytes for parent.

      • setParent

        public PurgeDocumentsRequest.Builder setParent​(String value)
         Required. The parent resource name, such as
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The parent to set.
        Returns:
        This builder for chaining.

      • clearParent

        public PurgeDocumentsRequest.Builder clearParent()
         Required. The parent resource name, such as
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • setParentBytes

        public PurgeDocumentsRequest.Builder setParentBytes​(com.google.protobuf.ByteString value)
         Required. The parent resource name, such as
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for parent to set.
        Returns:
        This builder for chaining.

      • getFilter

        public String getFilter()
         Required. Filter matching documents to purge. Only currently supported
 value is
 `*` (all items).
        string filter = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getFilter in interface PurgeDocumentsRequestOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         Required. Filter matching documents to purge. Only currently supported
 value is
 `*` (all items).
        string filter = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getFilterBytes in interface PurgeDocumentsRequestOrBuilder
        Returns:
        The bytes for filter.

      • setFilter

        public PurgeDocumentsRequest.Builder setFilter​(String value)
         Required. Filter matching documents to purge. Only currently supported
 value is
 `*` (all items).
        string filter = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The filter to set.
        Returns:
        This builder for chaining.

      • clearFilter

        public PurgeDocumentsRequest.Builder clearFilter()
         Required. Filter matching documents to purge. Only currently supported
 value is
 `*` (all items).
        string filter = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • setFilterBytes

        public PurgeDocumentsRequest.Builder setFilterBytes​(com.google.protobuf.ByteString value)
         Required. Filter matching documents to purge. Only currently supported
 value is
 `*` (all items).
        string filter = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes for filter to set.
        Returns:
        This builder for chaining.

      • getForce

        public boolean getForce()
         Actually performs the purge. If `force` is set to false, return the
 expected purge count without deleting any documents.
        bool force = 3;
        Specified by:
        getForce in interface PurgeDocumentsRequestOrBuilder
        Returns:
        The force.

      • setForce

        public PurgeDocumentsRequest.Builder setForce​(boolean value)
         Actually performs the purge. If `force` is set to false, return the
 expected purge count without deleting any documents.
        bool force = 3;
        Parameters:
        value - The force to set.
        Returns:
        This builder for chaining.

      • clearForce

        public PurgeDocumentsRequest.Builder clearForce()
         Actually performs the purge. If `force` is set to false, return the
 expected purge count without deleting any documents.
        bool force = 3;
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final PurgeDocumentsRequest.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsRequest.Builder>

      • mergeUnknownFields

        public final PurgeDocumentsRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsRequest.Builder>