Class: Google::Apis::CloudsearchV1::PollItemsRequest

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PollItemsRequest

Returns a new instance of PollItemsRequest.



2873
2874
2875
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2873

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

Instance Attribute Details

#connector_name ⇒ String

Name of connector making this call. Format: datasources/source_id/connectors/ ID Corresponds to the JSON property connectorName

Returns:

  • (String) 


2849
2850
2851
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2849

def connector_name
  @connector_name
end

#debug_options ⇒ Google::Apis::CloudsearchV1::DebugOptions

Shared request debug options for all cloudsearch RPC methods. Corresponds to the JSON property debugOptions

Returns:



2854
2855
2856
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2854

def debug_options
  @debug_options
end

#limit ⇒ Fixnum

Maximum number of items to return. The maximum value is 100 and the default value is 20. Corresponds to the JSON property limit

Returns:

  • (Fixnum) 


2860
2861
2862
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2860

def limit
  @limit
end

#queue ⇒ String

Queue name to fetch items from. If unspecified, PollItems will fetch from ' default' queue. The maximum length is 100 characters. Corresponds to the JSON property queue

Returns:

  • (String) 


2866
2867
2868
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2866

def queue
  @queue
end

#status_codes ⇒ Array<String>

Limit the items polled to the ones with these statuses. Corresponds to the JSON property statusCodes

Returns:

  • (Array<String>) 


2871
2872
2873
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2871

def status_codes
  @status_codes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2878
2879
2880
2881
2882
2883
2884
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2878

def update!(**args)
  @connector_name = args[:connector_name] if args.key?(:connector_name)
  @debug_options = args[:debug_options] if args.key?(:debug_options)
  @limit = args[:limit] if args.key?(:limit)
  @queue = args[:queue] if args.key?(:queue)
  @status_codes = args[:status_codes] if args.key?(:status_codes)
end