Package com.google.cloud.discoveryengine.v1alpha

Class GetProcessedDocumentRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<GetProcessedDocumentRequest.Builder>
com.google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.Builder
All Implemented Interfaces:
GetProcessedDocumentRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
GetProcessedDocumentRequest
public static final class GetProcessedDocumentRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<GetProcessedDocumentRequest.Builder> implements GetProcessedDocumentRequestOrBuilder
 Request message for
 [DocumentService.GetDocument][google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument]
 method.
Protobuf type google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest

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

    • clear

      public GetProcessedDocumentRequest.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.GeneratedMessage.Builder<GetProcessedDocumentRequest.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.GeneratedMessage.Builder<GetProcessedDocumentRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public GetProcessedDocumentRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GetProcessedDocumentRequest.Builder>

    • mergeFrom

      public GetProcessedDocumentRequest.Builder mergeFrom(GetProcessedDocumentRequest other)

    • isInitialized

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

    • mergeFrom

      public GetProcessedDocumentRequest.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<GetProcessedDocumentRequest.Builder>
      Throws:
      IOException

    • getName

      public String getName()
       Required. Full resource name of
 [Document][google.cloud.discoveryengine.v1alpha.Document], such as
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.

 If the caller does not have permission to access the
 [Document][google.cloud.discoveryengine.v1alpha.Document], regardless of
 whether or not it exists, a `PERMISSION_DENIED` error is returned.

 If the requested [Document][google.cloud.discoveryengine.v1alpha.Document]
 does not exist, a `NOT_FOUND` error is returned.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getName in interface GetProcessedDocumentRequestOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Required. Full resource name of
 [Document][google.cloud.discoveryengine.v1alpha.Document], such as
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.

 If the caller does not have permission to access the
 [Document][google.cloud.discoveryengine.v1alpha.Document], regardless of
 whether or not it exists, a `PERMISSION_DENIED` error is returned.

 If the requested [Document][google.cloud.discoveryengine.v1alpha.Document]
 does not exist, a `NOT_FOUND` error is returned.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getNameBytes in interface GetProcessedDocumentRequestOrBuilder
      Returns:
      The bytes for name.

    • setName

      public GetProcessedDocumentRequest.Builder setName(String value)
       Required. Full resource name of
 [Document][google.cloud.discoveryengine.v1alpha.Document], such as
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.

 If the caller does not have permission to access the
 [Document][google.cloud.discoveryengine.v1alpha.Document], regardless of
 whether or not it exists, a `PERMISSION_DENIED` error is returned.

 If the requested [Document][google.cloud.discoveryengine.v1alpha.Document]
 does not exist, a `NOT_FOUND` error is returned.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public GetProcessedDocumentRequest.Builder clearName()
       Required. Full resource name of
 [Document][google.cloud.discoveryengine.v1alpha.Document], such as
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.

 If the caller does not have permission to access the
 [Document][google.cloud.discoveryengine.v1alpha.Document], regardless of
 whether or not it exists, a `PERMISSION_DENIED` error is returned.

 If the requested [Document][google.cloud.discoveryengine.v1alpha.Document]
 does not exist, a `NOT_FOUND` error is returned.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setNameBytes

      public GetProcessedDocumentRequest.Builder setNameBytes(com.google.protobuf.ByteString value)
       Required. Full resource name of
 [Document][google.cloud.discoveryengine.v1alpha.Document], such as
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.

 If the caller does not have permission to access the
 [Document][google.cloud.discoveryengine.v1alpha.Document], regardless of
 whether or not it exists, a `PERMISSION_DENIED` error is returned.

 If the requested [Document][google.cloud.discoveryengine.v1alpha.Document]
 does not exist, a `NOT_FOUND` error is returned.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • getProcessedDocumentTypeValue

      public int getProcessedDocumentTypeValue()
       Required. What type of processing to return.
      .google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentType processed_document_type = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getProcessedDocumentTypeValue in interface GetProcessedDocumentRequestOrBuilder
      Returns:
      The enum numeric value on the wire for processedDocumentType.

    • setProcessedDocumentTypeValue

      public GetProcessedDocumentRequest.Builder setProcessedDocumentTypeValue(int value)
       Required. What type of processing to return.
      .google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentType processed_document_type = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The enum numeric value on the wire for processedDocumentType to set.
      Returns:
      This builder for chaining.

    • getProcessedDocumentType

      public GetProcessedDocumentRequest.ProcessedDocumentType getProcessedDocumentType()
       Required. What type of processing to return.
      .google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentType processed_document_type = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getProcessedDocumentType in interface GetProcessedDocumentRequestOrBuilder
      Returns:
      The processedDocumentType.

    • setProcessedDocumentType

      public GetProcessedDocumentRequest.Builder setProcessedDocumentType(GetProcessedDocumentRequest.ProcessedDocumentType value)
       Required. What type of processing to return.
      .google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentType processed_document_type = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The processedDocumentType to set.
      Returns:
      This builder for chaining.

    • clearProcessedDocumentType

      public GetProcessedDocumentRequest.Builder clearProcessedDocumentType()
       Required. What type of processing to return.
      .google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentType processed_document_type = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • getProcessedDocumentFormatValue

      public int getProcessedDocumentFormatValue()
       What format output should be.  If unspecified, defaults to JSON.
      .google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentFormat processed_document_format = 3;
      Specified by:
      getProcessedDocumentFormatValue in interface GetProcessedDocumentRequestOrBuilder
      Returns:
      The enum numeric value on the wire for processedDocumentFormat.

    • setProcessedDocumentFormatValue

      public GetProcessedDocumentRequest.Builder setProcessedDocumentFormatValue(int value)
       What format output should be.  If unspecified, defaults to JSON.
      .google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentFormat processed_document_format = 3;
      Parameters:
      value - The enum numeric value on the wire for processedDocumentFormat to set.
      Returns:
      This builder for chaining.

    • getProcessedDocumentFormat

      public GetProcessedDocumentRequest.ProcessedDocumentFormat getProcessedDocumentFormat()
       What format output should be.  If unspecified, defaults to JSON.
      .google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentFormat processed_document_format = 3;
      Specified by:
      getProcessedDocumentFormat in interface GetProcessedDocumentRequestOrBuilder
      Returns:
      The processedDocumentFormat.

    • setProcessedDocumentFormat

      public GetProcessedDocumentRequest.Builder setProcessedDocumentFormat(GetProcessedDocumentRequest.ProcessedDocumentFormat value)
       What format output should be.  If unspecified, defaults to JSON.
      .google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentFormat processed_document_format = 3;
      Parameters:
      value - The processedDocumentFormat to set.
      Returns:
      This builder for chaining.

    • clearProcessedDocumentFormat

      public GetProcessedDocumentRequest.Builder clearProcessedDocumentFormat()
       What format output should be.  If unspecified, defaults to JSON.
      .google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentFormat processed_document_format = 3;
      Returns:
      This builder for chaining.