Class: Gapic::PagedEnumerable::Page

Inherits:

Object

• Object
• Gapic::PagedEnumerable::Page

Includes:

Enumerable

Defined in:

lib/gapic/paged_enumerable.rb

Overview

A class to represent a page in a PagedEnumerable. This also implements Enumerable, so it can iterate over the resource elements.

Instance Attribute Summary

• #operation ⇒ ::GRPC::ActiveCall::Operation readonly

  The RPC operation for the page.

• #response ⇒ Object readonly

  The response object for the page.

Instance Method Summary

• #each {|Object| ... } ⇒ Object

  Iterate over the resources.

• #next_page_token ⇒ String

  The page token to be used for the next RPC call.

• #next_page_token? ⇒ Boolean

  Truthiness of next_page_token.

Instance Attribute Details

#operation ⇒ ::GRPC::ActiveCall::Operation (readonly)

Returns the RPC operation for the page.

Returns:

• (::GRPC::ActiveCall::Operation) —

  the RPC operation for the page.

# File 'lib/gapic/paged_enumerable.rb', line 199

class Page
  include Enumerable
  attr_reader :response
  attr_reader :operation

  ##
  # @private
  # @param response [Object] The response object for the page.
  # @param resource_field [String] The name of the field in response which holds the resources.
  # @param operation [::GRPC::ActiveCall::Operation] the RPC operation for the page.
  # @param format_resource [Proc] A Proc object to format the resource object. The Proc should accept response as an
  #   argument, and return a formatted resource object. Optional.
  #
  def initialize response, resource_field, operation, format_resource: nil
    @response = response
    @resource_field = resource_field
    @operation = operation
    @format_resource = format_resource
  end

  ##
  # Iterate over the resources.
  #
  # @yield [Object] Gives the resource objects in the page.
  #
  def each
    return enum_for :each unless block_given?

    return if @response.nil?

    # We trust that the field exists and is an Enumerable
    @response[@resource_field].each do |resource|
      resource = @format_resource.call resource if @format_resource
      yield resource
    end
  end

  ##
  # The page token to be used for the next RPC call.
  #
  # @return [String]
  #
  def next_page_token
    return if @response.nil?

    @response.next_page_token
  end

  ##
  # Truthiness of next_page_token.
  #
  # @return [Boolean]
  #
  def next_page_token?
    return if @response.nil? # rubocop:disable Style/ReturnNilInPredicateMethodDefinition

    !@response.next_page_token.empty?
  end
end

#response ⇒ Object (readonly)

Returns the response object for the page.

Returns:

• (Object) —

  the response object for the page.

# File 'lib/gapic/paged_enumerable.rb', line 199

class Page
  include Enumerable
  attr_reader :response
  attr_reader :operation

  ##
  # @private
  # @param response [Object] The response object for the page.
  # @param resource_field [String] The name of the field in response which holds the resources.
  # @param operation [::GRPC::ActiveCall::Operation] the RPC operation for the page.
  # @param format_resource [Proc] A Proc object to format the resource object. The Proc should accept response as an
  #   argument, and return a formatted resource object. Optional.
  #
  def initialize response, resource_field, operation, format_resource: nil
    @response = response
    @resource_field = resource_field
    @operation = operation
    @format_resource = format_resource
  end

  ##
  # Iterate over the resources.
  #
  # @yield [Object] Gives the resource objects in the page.
  #
  def each
    return enum_for :each unless block_given?

    return if @response.nil?

    # We trust that the field exists and is an Enumerable
    @response[@resource_field].each do |resource|
      resource = @format_resource.call resource if @format_resource
      yield resource
    end
  end

  ##
  # The page token to be used for the next RPC call.
  #
  # @return [String]
  #
  def next_page_token
    return if @response.nil?

    @response.next_page_token
  end

  ##
  # Truthiness of next_page_token.
  #
  # @return [Boolean]
  #
  def next_page_token?
    return if @response.nil? # rubocop:disable Style/ReturnNilInPredicateMethodDefinition

    !@response.next_page_token.empty?
  end
end

Instance Method Details

#each {|Object| ... } ⇒ Object

Iterate over the resources.

Yields:

• (Object) —

  Gives the resource objects in the page.

# File 'lib/gapic/paged_enumerable.rb', line 224

def each
  return enum_for :each unless block_given?

  return if @response.nil?

  # We trust that the field exists and is an Enumerable
  @response[@resource_field].each do |resource|
    resource = @format_resource.call resource if @format_resource
    yield resource
  end
end

#next_page_token ⇒ String

The page token to be used for the next RPC call.

Returns:

• (String)

# File 'lib/gapic/paged_enumerable.rb', line 241

def next_page_token
  return if @response.nil?

  @response.next_page_token
end

#next_page_token? ⇒ Boolean

Truthiness of next_page_token.

Returns:

• (Boolean)

# File 'lib/gapic/paged_enumerable.rb', line 252

def next_page_token?
  return if @response.nil? # rubocop:disable Style/ReturnNilInPredicateMethodDefinition

  !@response.next_page_token.empty?
end