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

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ PollItemsRequest

Returns a new instance of PollItemsRequest.



2824
2825
2826
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2824

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

Instance Attribute Details

#connector_nameString

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

Returns:

  • (String)


2799
2800
2801
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2799

def connector_name
  @connector_name
end

#debug_optionsGoogle::Apis::CloudsearchV1::DebugOptions

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



2804
2805
2806
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2804

def debug_options
  @debug_options
end

#limitFixnum

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)


2810
2811
2812
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2810

def limit
  @limit
end

#queueString

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)


2817
2818
2819
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2817

def queue
  @queue
end

#status_codesArray<String>

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

Returns:

  • (Array<String>)


2822
2823
2824
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2822

def status_codes
  @status_codes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2829
2830
2831
2832
2833
2834
2835
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2829

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