Package com.google.cloud.discoveryengine.v1beta

Class TargetSite

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1beta.TargetSite
All Implemented Interfaces:
TargetSiteOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class TargetSite extends com.google.protobuf.GeneratedMessage implements TargetSiteOrBuilder
 A target site for the SiteSearchEngine.
Protobuf type google.cloud.discoveryengine.v1beta.TargetSite
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • PROVIDED_URI_PATTERN_FIELD_NUMBER

      public static final int PROVIDED_URI_PATTERN_FIELD_NUMBER
      See Also:

    • TYPE_FIELD_NUMBER

      public static final int TYPE_FIELD_NUMBER
      See Also:

    • EXACT_MATCH_FIELD_NUMBER

      public static final int EXACT_MATCH_FIELD_NUMBER
      See Also:

    • GENERATED_URI_PATTERN_FIELD_NUMBER

      public static final int GENERATED_URI_PATTERN_FIELD_NUMBER
      See Also:

    • ROOT_DOMAIN_URI_FIELD_NUMBER

      public static final int ROOT_DOMAIN_URI_FIELD_NUMBER
      See Also:

    • SITE_VERIFICATION_INFO_FIELD_NUMBER

      public static final int SITE_VERIFICATION_INFO_FIELD_NUMBER
      See Also:

    • INDEXING_STATUS_FIELD_NUMBER

      public static final int INDEXING_STATUS_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • FAILURE_REASON_FIELD_NUMBER

      public static final int FAILURE_REASON_FIELD_NUMBER
      See Also:

  • 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

    • getName

      public String getName()
       Output only. The fully qualified resource name of the target site.
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`
 The `target_site_id` is system-generated.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getName in interface TargetSiteOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Output only. The fully qualified resource name of the target site.
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`
 The `target_site_id` is system-generated.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getNameBytes in interface TargetSiteOrBuilder
      Returns:
      The bytes for name.

    • getProvidedUriPattern

      public String getProvidedUriPattern()
       Required. Input only. The user provided URI pattern from which the
 `generated_uri_pattern` is generated.
      string provided_uri_pattern = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = INPUT_ONLY];
      Specified by:
      getProvidedUriPattern in interface TargetSiteOrBuilder
      Returns:
      The providedUriPattern.

    • getProvidedUriPatternBytes

      public com.google.protobuf.ByteString getProvidedUriPatternBytes()
       Required. Input only. The user provided URI pattern from which the
 `generated_uri_pattern` is generated.
      string provided_uri_pattern = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = INPUT_ONLY];
      Specified by:
      getProvidedUriPatternBytes in interface TargetSiteOrBuilder
      Returns:
      The bytes for providedUriPattern.

    • getTypeValue

      public int getTypeValue()
       The type of the target site, e.g., whether the site is to be included or
 excluded.
      .google.cloud.discoveryengine.v1beta.TargetSite.Type type = 3;
      Specified by:
      getTypeValue in interface TargetSiteOrBuilder
      Returns:
      The enum numeric value on the wire for type.

    • getType

      public TargetSite.Type getType()
       The type of the target site, e.g., whether the site is to be included or
 excluded.
      .google.cloud.discoveryengine.v1beta.TargetSite.Type type = 3;
      Specified by:
      getType in interface TargetSiteOrBuilder
      Returns:
      The type.

    • getExactMatch

      public boolean getExactMatch()
       Input only. If set to false, a uri_pattern is generated to include all
 pages whose address contains the provided_uri_pattern. If set to true, an
 uri_pattern is generated to try to be an exact match of the
 provided_uri_pattern or just the specific page if the provided_uri_pattern
 is a specific one. provided_uri_pattern is always normalized to
 generate the URI pattern to be used by the search engine.
      bool exact_match = 6 [(.google.api.field_behavior) = INPUT_ONLY];
      Specified by:
      getExactMatch in interface TargetSiteOrBuilder
      Returns:
      The exactMatch.

    • getGeneratedUriPattern

      public String getGeneratedUriPattern()
       Output only. This is system-generated based on the provided_uri_pattern.
      string generated_uri_pattern = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getGeneratedUriPattern in interface TargetSiteOrBuilder
      Returns:
      The generatedUriPattern.

    • getGeneratedUriPatternBytes

      public com.google.protobuf.ByteString getGeneratedUriPatternBytes()
       Output only. This is system-generated based on the provided_uri_pattern.
      string generated_uri_pattern = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getGeneratedUriPatternBytes in interface TargetSiteOrBuilder
      Returns:
      The bytes for generatedUriPattern.

    • getRootDomainUri

      public String getRootDomainUri()
       Output only. Root domain of the provided_uri_pattern.
      string root_domain_uri = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getRootDomainUri in interface TargetSiteOrBuilder
      Returns:
      The rootDomainUri.

    • getRootDomainUriBytes

      public com.google.protobuf.ByteString getRootDomainUriBytes()
       Output only. Root domain of the provided_uri_pattern.
      string root_domain_uri = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getRootDomainUriBytes in interface TargetSiteOrBuilder
      Returns:
      The bytes for rootDomainUri.

    • hasSiteVerificationInfo

      public boolean hasSiteVerificationInfo()
       Output only. Site ownership and validity verification status.
      .google.cloud.discoveryengine.v1beta.SiteVerificationInfo site_verification_info = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasSiteVerificationInfo in interface TargetSiteOrBuilder
      Returns:
      Whether the siteVerificationInfo field is set.

    • getSiteVerificationInfo

      public SiteVerificationInfo getSiteVerificationInfo()
       Output only. Site ownership and validity verification status.
      .google.cloud.discoveryengine.v1beta.SiteVerificationInfo site_verification_info = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSiteVerificationInfo in interface TargetSiteOrBuilder
      Returns:
      The siteVerificationInfo.

    • getSiteVerificationInfoOrBuilder

      public SiteVerificationInfoOrBuilder getSiteVerificationInfoOrBuilder()
       Output only. Site ownership and validity verification status.
      .google.cloud.discoveryengine.v1beta.SiteVerificationInfo site_verification_info = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSiteVerificationInfoOrBuilder in interface TargetSiteOrBuilder

    • getIndexingStatusValue

      public int getIndexingStatusValue()
       Output only. Indexing status.
      .google.cloud.discoveryengine.v1beta.TargetSite.IndexingStatus indexing_status = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getIndexingStatusValue in interface TargetSiteOrBuilder
      Returns:
      The enum numeric value on the wire for indexingStatus.

    • getIndexingStatus

      public TargetSite.IndexingStatus getIndexingStatus()
       Output only. Indexing status.
      .google.cloud.discoveryengine.v1beta.TargetSite.IndexingStatus indexing_status = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getIndexingStatus in interface TargetSiteOrBuilder
      Returns:
      The indexingStatus.

    • hasUpdateTime

      public boolean hasUpdateTime()
       Output only. The target site's last updated time.
      .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasUpdateTime in interface TargetSiteOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       Output only. The target site's last updated time.
      .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTime in interface TargetSiteOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The target site's last updated time.
      .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface TargetSiteOrBuilder

    • hasFailureReason

      public boolean hasFailureReason()
       Output only. Failure reason.
      .google.cloud.discoveryengine.v1beta.TargetSite.FailureReason failure_reason = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasFailureReason in interface TargetSiteOrBuilder
      Returns:
      Whether the failureReason field is set.

    • getFailureReason

      public TargetSite.FailureReason getFailureReason()
       Output only. Failure reason.
      .google.cloud.discoveryengine.v1beta.TargetSite.FailureReason failure_reason = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getFailureReason in interface TargetSiteOrBuilder
      Returns:
      The failureReason.

    • getFailureReasonOrBuilder

      public TargetSite.FailureReasonOrBuilder getFailureReasonOrBuilder()
       Output only. Failure reason.
      .google.cloud.discoveryengine.v1beta.TargetSite.FailureReason failure_reason = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getFailureReasonOrBuilder in interface TargetSiteOrBuilder

    • 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 TargetSite parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static TargetSite parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static TargetSite parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static TargetSite.Builder newBuilder()

    • newBuilder

      public static TargetSite.Builder newBuilder(TargetSite prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static TargetSite getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<TargetSite> parser()

    • getParserForType

      public com.google.protobuf.Parser<TargetSite> 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 TargetSite getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder