Package com.google.cloud.discoveryengine.v1beta

Interface TargetSiteOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
TargetSite, TargetSite.Builder
@Generated public interface TargetSiteOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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];
      Returns:
      The name.

    • getNameBytes

      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];
      Returns:
      The bytes for name.

    • getProvidedUriPattern

      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];
      Returns:
      The providedUriPattern.

    • getProvidedUriPatternBytes

      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];
      Returns:
      The bytes for providedUriPattern.

    • getTypeValue

      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;
      Returns:
      The enum numeric value on the wire for type.

    • getType

      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;
      Returns:
      The type.

    • getExactMatch

      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];
      Returns:
      The exactMatch.

    • getGeneratedUriPattern

      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];
      Returns:
      The generatedUriPattern.

    • getGeneratedUriPatternBytes

      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];
      Returns:
      The bytes for generatedUriPattern.

    • getRootDomainUri

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

    • getRootDomainUriBytes

      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];
      Returns:
      The bytes for rootDomainUri.

    • hasSiteVerificationInfo

      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];
      Returns:
      Whether the siteVerificationInfo field is set.

    • getSiteVerificationInfo

      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];
      Returns:
      The siteVerificationInfo.

    • getSiteVerificationInfoOrBuilder

      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];

    • getIndexingStatusValue

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

    • getIndexingStatus

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

    • hasUpdateTime

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

    • getUpdateTime

      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];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      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];

    • hasFailureReason

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

    • getFailureReason

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

    • getFailureReasonOrBuilder

      TargetSite.FailureReasonOrBuilder getFailureReasonOrBuilder()
       Output only. Failure reason.
      .google.cloud.discoveryengine.v1beta.TargetSite.FailureReason failure_reason = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];