Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1beta/classes.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb

Overview

Response message for CrawlRateManagementService.ObtainCrawlRate method. The response contains organcic or dedicated crawl rate time series data for monitoring, depending on whether dedicated crawl rate is set.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse

Returns a new instance of GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.



28451
28452
28453
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 28451

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#dedicated_crawl_rate_time_series ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries

The historical dedicated crawl rate timeseries data, used for monitoring. Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate crawl is set. Corresponds to the JSON property dedicatedCrawlRateTimeSeries

Returns:



28426
28427
28428
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 28426

def dedicated_crawl_rate_time_series
  @dedicated_crawl_rate_time_series
end

#error ⇒ Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. Corresponds to the JSON property error

Returns:



28436
28437
28438
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 28436

def error
  @error
end

#organic_crawl_rate_time_series ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries

The historical organic crawl rate timeseries data, used for monitoring. Organic crawl is auto-determined by Google to crawl the user's website when dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends to the user's website. Corresponds to the JSON property organicCrawlRateTimeSeries

Returns:



28444
28445
28446
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 28444

def organic_crawl_rate_time_series
  @organic_crawl_rate_time_series
end

#state ⇒ String

Output only. The state of the response. Corresponds to the JSON property state

Returns:

  • (String) 


28449
28450
28451
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 28449

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



28456
28457
28458
28459
28460
28461
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 28456

def update!(**args)
  @dedicated_crawl_rate_time_series = args[:dedicated_crawl_rate_time_series] if args.key?(:dedicated_crawl_rate_time_series)
  @error = args[:error] if args.key?(:error)
  @organic_crawl_rate_time_series = args[:organic_crawl_rate_time_series] if args.key?(:organic_crawl_rate_time_series)
  @state = args[:state] if args.key?(:state)
end