Class: Google::Cloud::DiscoveryEngine::V1beta::TargetSite

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb

Overview

A target site for the SiteSearchEngine.

Defined Under Namespace

Modules: IndexingStatus, Type Classes: FailureReason

Instance Attribute Summary collapse

Instance Attribute Details

#exact_match ⇒ ::Boolean 



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb', line 75

class TargetSite
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Site search indexing failure reasons.
  # @!attribute [rw] quota_failure
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::TargetSite::FailureReason::QuotaFailure]
  #     Failed due to insufficient quota.
  class FailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Failed due to insufficient quota.
    # @!attribute [rw] total_required_quota
    #   @return [::Integer]
    #     This number is an estimation on how much total quota this project needs
    #     to successfully complete indexing.
    class QuotaFailure
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Possible target site types.
  module Type
    # This value is unused. In this case, server behavior defaults to
    # {::Google::Cloud::DiscoveryEngine::V1beta::TargetSite::Type::INCLUDE Type.INCLUDE}.
    TYPE_UNSPECIFIED = 0

    # Include the target site.
    INCLUDE = 1

    # Exclude the target site.
    EXCLUDE = 2
  end

  # Target site indexing status enumeration.
  module IndexingStatus
    # Defaults to SUCCEEDED.
    INDEXING_STATUS_UNSPECIFIED = 0

    # The target site is in the update queue and will be picked up by indexing
    # pipeline.
    PENDING = 1

    # The target site fails to be indexed.
    FAILED = 2

    # The target site has been indexed.
    SUCCEEDED = 3

    # The previously indexed target site has been marked to be deleted. This is
    # a transitioning state which will resulted in either:
    # 1. target site deleted if unindexing is successful;
    # 2. state reverts to SUCCEEDED if the unindexing fails.
    DELETING = 4
  end
end

#failure_reason ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::TargetSite::FailureReason (readonly) 



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb', line 75

class TargetSite
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Site search indexing failure reasons.
  # @!attribute [rw] quota_failure
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::TargetSite::FailureReason::QuotaFailure]
  #     Failed due to insufficient quota.
  class FailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Failed due to insufficient quota.
    # @!attribute [rw] total_required_quota
    #   @return [::Integer]
    #     This number is an estimation on how much total quota this project needs
    #     to successfully complete indexing.
    class QuotaFailure
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Possible target site types.
  module Type
    # This value is unused. In this case, server behavior defaults to
    # {::Google::Cloud::DiscoveryEngine::V1beta::TargetSite::Type::INCLUDE Type.INCLUDE}.
    TYPE_UNSPECIFIED = 0

    # Include the target site.
    INCLUDE = 1

    # Exclude the target site.
    EXCLUDE = 2
  end

  # Target site indexing status enumeration.
  module IndexingStatus
    # Defaults to SUCCEEDED.
    INDEXING_STATUS_UNSPECIFIED = 0

    # The target site is in the update queue and will be picked up by indexing
    # pipeline.
    PENDING = 1

    # The target site fails to be indexed.
    FAILED = 2

    # The target site has been indexed.
    SUCCEEDED = 3

    # The previously indexed target site has been marked to be deleted. This is
    # a transitioning state which will resulted in either:
    # 1. target site deleted if unindexing is successful;
    # 2. state reverts to SUCCEEDED if the unindexing fails.
    DELETING = 4
  end
end

#generated_uri_pattern ⇒ ::String (readonly) 



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb', line 75

class TargetSite
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Site search indexing failure reasons.
  # @!attribute [rw] quota_failure
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::TargetSite::FailureReason::QuotaFailure]
  #     Failed due to insufficient quota.
  class FailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Failed due to insufficient quota.
    # @!attribute [rw] total_required_quota
    #   @return [::Integer]
    #     This number is an estimation on how much total quota this project needs
    #     to successfully complete indexing.
    class QuotaFailure
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Possible target site types.
  module Type
    # This value is unused. In this case, server behavior defaults to
    # {::Google::Cloud::DiscoveryEngine::V1beta::TargetSite::Type::INCLUDE Type.INCLUDE}.
    TYPE_UNSPECIFIED = 0

    # Include the target site.
    INCLUDE = 1

    # Exclude the target site.
    EXCLUDE = 2
  end

  # Target site indexing status enumeration.
  module IndexingStatus
    # Defaults to SUCCEEDED.
    INDEXING_STATUS_UNSPECIFIED = 0

    # The target site is in the update queue and will be picked up by indexing
    # pipeline.
    PENDING = 1

    # The target site fails to be indexed.
    FAILED = 2

    # The target site has been indexed.
    SUCCEEDED = 3

    # The previously indexed target site has been marked to be deleted. This is
    # a transitioning state which will resulted in either:
    # 1. target site deleted if unindexing is successful;
    # 2. state reverts to SUCCEEDED if the unindexing fails.
    DELETING = 4
  end
end

#indexing_status ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::TargetSite::IndexingStatus (readonly) 



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb', line 75

class TargetSite
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Site search indexing failure reasons.
  # @!attribute [rw] quota_failure
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::TargetSite::FailureReason::QuotaFailure]
  #     Failed due to insufficient quota.
  class FailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Failed due to insufficient quota.
    # @!attribute [rw] total_required_quota
    #   @return [::Integer]
    #     This number is an estimation on how much total quota this project needs
    #     to successfully complete indexing.
    class QuotaFailure
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Possible target site types.
  module Type
    # This value is unused. In this case, server behavior defaults to
    # {::Google::Cloud::DiscoveryEngine::V1beta::TargetSite::Type::INCLUDE Type.INCLUDE}.
    TYPE_UNSPECIFIED = 0

    # Include the target site.
    INCLUDE = 1

    # Exclude the target site.
    EXCLUDE = 2
  end

  # Target site indexing status enumeration.
  module IndexingStatus
    # Defaults to SUCCEEDED.
    INDEXING_STATUS_UNSPECIFIED = 0

    # The target site is in the update queue and will be picked up by indexing
    # pipeline.
    PENDING = 1

    # The target site fails to be indexed.
    FAILED = 2

    # The target site has been indexed.
    SUCCEEDED = 3

    # The previously indexed target site has been marked to be deleted. This is
    # a transitioning state which will resulted in either:
    # 1. target site deleted if unindexing is successful;
    # 2. state reverts to SUCCEEDED if the unindexing fails.
    DELETING = 4
  end
end

#name ⇒ ::String (readonly) 



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb', line 75

class TargetSite
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Site search indexing failure reasons.
  # @!attribute [rw] quota_failure
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::TargetSite::FailureReason::QuotaFailure]
  #     Failed due to insufficient quota.
  class FailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Failed due to insufficient quota.
    # @!attribute [rw] total_required_quota
    #   @return [::Integer]
    #     This number is an estimation on how much total quota this project needs
    #     to successfully complete indexing.
    class QuotaFailure
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Possible target site types.
  module Type
    # This value is unused. In this case, server behavior defaults to
    # {::Google::Cloud::DiscoveryEngine::V1beta::TargetSite::Type::INCLUDE Type.INCLUDE}.
    TYPE_UNSPECIFIED = 0

    # Include the target site.
    INCLUDE = 1

    # Exclude the target site.
    EXCLUDE = 2
  end

  # Target site indexing status enumeration.
  module IndexingStatus
    # Defaults to SUCCEEDED.
    INDEXING_STATUS_UNSPECIFIED = 0

    # The target site is in the update queue and will be picked up by indexing
    # pipeline.
    PENDING = 1

    # The target site fails to be indexed.
    FAILED = 2

    # The target site has been indexed.
    SUCCEEDED = 3

    # The previously indexed target site has been marked to be deleted. This is
    # a transitioning state which will resulted in either:
    # 1. target site deleted if unindexing is successful;
    # 2. state reverts to SUCCEEDED if the unindexing fails.
    DELETING = 4
  end
end

#provided_uri_pattern ⇒ ::String 



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb', line 75

class TargetSite
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Site search indexing failure reasons.
  # @!attribute [rw] quota_failure
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::TargetSite::FailureReason::QuotaFailure]
  #     Failed due to insufficient quota.
  class FailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Failed due to insufficient quota.
    # @!attribute [rw] total_required_quota
    #   @return [::Integer]
    #     This number is an estimation on how much total quota this project needs
    #     to successfully complete indexing.
    class QuotaFailure
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Possible target site types.
  module Type
    # This value is unused. In this case, server behavior defaults to
    # {::Google::Cloud::DiscoveryEngine::V1beta::TargetSite::Type::INCLUDE Type.INCLUDE}.
    TYPE_UNSPECIFIED = 0

    # Include the target site.
    INCLUDE = 1

    # Exclude the target site.
    EXCLUDE = 2
  end

  # Target site indexing status enumeration.
  module IndexingStatus
    # Defaults to SUCCEEDED.
    INDEXING_STATUS_UNSPECIFIED = 0

    # The target site is in the update queue and will be picked up by indexing
    # pipeline.
    PENDING = 1

    # The target site fails to be indexed.
    FAILED = 2

    # The target site has been indexed.
    SUCCEEDED = 3

    # The previously indexed target site has been marked to be deleted. This is
    # a transitioning state which will resulted in either:
    # 1. target site deleted if unindexing is successful;
    # 2. state reverts to SUCCEEDED if the unindexing fails.
    DELETING = 4
  end
end

#root_domain_uri ⇒ ::String (readonly) 



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb', line 75

class TargetSite
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Site search indexing failure reasons.
  # @!attribute [rw] quota_failure
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::TargetSite::FailureReason::QuotaFailure]
  #     Failed due to insufficient quota.
  class FailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Failed due to insufficient quota.
    # @!attribute [rw] total_required_quota
    #   @return [::Integer]
    #     This number is an estimation on how much total quota this project needs
    #     to successfully complete indexing.
    class QuotaFailure
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Possible target site types.
  module Type
    # This value is unused. In this case, server behavior defaults to
    # {::Google::Cloud::DiscoveryEngine::V1beta::TargetSite::Type::INCLUDE Type.INCLUDE}.
    TYPE_UNSPECIFIED = 0

    # Include the target site.
    INCLUDE = 1

    # Exclude the target site.
    EXCLUDE = 2
  end

  # Target site indexing status enumeration.
  module IndexingStatus
    # Defaults to SUCCEEDED.
    INDEXING_STATUS_UNSPECIFIED = 0

    # The target site is in the update queue and will be picked up by indexing
    # pipeline.
    PENDING = 1

    # The target site fails to be indexed.
    FAILED = 2

    # The target site has been indexed.
    SUCCEEDED = 3

    # The previously indexed target site has been marked to be deleted. This is
    # a transitioning state which will resulted in either:
    # 1. target site deleted if unindexing is successful;
    # 2. state reverts to SUCCEEDED if the unindexing fails.
    DELETING = 4
  end
end

#site_verification_info ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::SiteVerificationInfo (readonly) 



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb', line 75

class TargetSite
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Site search indexing failure reasons.
  # @!attribute [rw] quota_failure
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::TargetSite::FailureReason::QuotaFailure]
  #     Failed due to insufficient quota.
  class FailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Failed due to insufficient quota.
    # @!attribute [rw] total_required_quota
    #   @return [::Integer]
    #     This number is an estimation on how much total quota this project needs
    #     to successfully complete indexing.
    class QuotaFailure
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Possible target site types.
  module Type
    # This value is unused. In this case, server behavior defaults to
    # {::Google::Cloud::DiscoveryEngine::V1beta::TargetSite::Type::INCLUDE Type.INCLUDE}.
    TYPE_UNSPECIFIED = 0

    # Include the target site.
    INCLUDE = 1

    # Exclude the target site.
    EXCLUDE = 2
  end

  # Target site indexing status enumeration.
  module IndexingStatus
    # Defaults to SUCCEEDED.
    INDEXING_STATUS_UNSPECIFIED = 0

    # The target site is in the update queue and will be picked up by indexing
    # pipeline.
    PENDING = 1

    # The target site fails to be indexed.
    FAILED = 2

    # The target site has been indexed.
    SUCCEEDED = 3

    # The previously indexed target site has been marked to be deleted. This is
    # a transitioning state which will resulted in either:
    # 1. target site deleted if unindexing is successful;
    # 2. state reverts to SUCCEEDED if the unindexing fails.
    DELETING = 4
  end
end

#type ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::TargetSite::Type 



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb', line 75

class TargetSite
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Site search indexing failure reasons.
  # @!attribute [rw] quota_failure
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::TargetSite::FailureReason::QuotaFailure]
  #     Failed due to insufficient quota.
  class FailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Failed due to insufficient quota.
    # @!attribute [rw] total_required_quota
    #   @return [::Integer]
    #     This number is an estimation on how much total quota this project needs
    #     to successfully complete indexing.
    class QuotaFailure
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Possible target site types.
  module Type
    # This value is unused. In this case, server behavior defaults to
    # {::Google::Cloud::DiscoveryEngine::V1beta::TargetSite::Type::INCLUDE Type.INCLUDE}.
    TYPE_UNSPECIFIED = 0

    # Include the target site.
    INCLUDE = 1

    # Exclude the target site.
    EXCLUDE = 2
  end

  # Target site indexing status enumeration.
  module IndexingStatus
    # Defaults to SUCCEEDED.
    INDEXING_STATUS_UNSPECIFIED = 0

    # The target site is in the update queue and will be picked up by indexing
    # pipeline.
    PENDING = 1

    # The target site fails to be indexed.
    FAILED = 2

    # The target site has been indexed.
    SUCCEEDED = 3

    # The previously indexed target site has been marked to be deleted. This is
    # a transitioning state which will resulted in either:
    # 1. target site deleted if unindexing is successful;
    # 2. state reverts to SUCCEEDED if the unindexing fails.
    DELETING = 4
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly) 



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb', line 75

class TargetSite
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Site search indexing failure reasons.
  # @!attribute [rw] quota_failure
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::TargetSite::FailureReason::QuotaFailure]
  #     Failed due to insufficient quota.
  class FailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Failed due to insufficient quota.
    # @!attribute [rw] total_required_quota
    #   @return [::Integer]
    #     This number is an estimation on how much total quota this project needs
    #     to successfully complete indexing.
    class QuotaFailure
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Possible target site types.
  module Type
    # This value is unused. In this case, server behavior defaults to
    # {::Google::Cloud::DiscoveryEngine::V1beta::TargetSite::Type::INCLUDE Type.INCLUDE}.
    TYPE_UNSPECIFIED = 0

    # Include the target site.
    INCLUDE = 1

    # Exclude the target site.
    EXCLUDE = 2
  end

  # Target site indexing status enumeration.
  module IndexingStatus
    # Defaults to SUCCEEDED.
    INDEXING_STATUS_UNSPECIFIED = 0

    # The target site is in the update queue and will be picked up by indexing
    # pipeline.
    PENDING = 1

    # The target site fails to be indexed.
    FAILED = 2

    # The target site has been indexed.
    SUCCEEDED = 3

    # The previously indexed target site has been marked to be deleted. This is
    # a transitioning state which will resulted in either:
    # 1. target site deleted if unindexing is successful;
    # 2. state reverts to SUCCEEDED if the unindexing fails.
    DELETING = 4
  end
end