Google Cloud Support V2BETA API - Class Google::Cloud::Support::V2beta::FeedService::Rest::Client (v0.2.0)

Reference documentation and code samples for the Google Cloud Support V2BETA API class Google::Cloud::Support::V2beta::FeedService::Rest::Client.

REST client for the FeedService service.

A service to view case feed items.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the FeedService Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all FeedService clients
::Google::Cloud::Support::V2beta::FeedService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the FeedService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#initialize

def initialize() { |config| ... } -> Client

Create a new FeedService REST client object.

Yields
  • (config) — Configure the FeedService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::Support::V2beta::FeedService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Support::V2beta::FeedService::Rest::Client.new do |config|
  config.timeout = 10.0
end

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#show_feed

def show_feed(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Support::V2beta::FeedItem>
def show_feed(parent: nil, order_by: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Support::V2beta::FeedItem>

Show items in the feed of this case, including case emails, attachments, and comments.

Overloads 
def show_feed(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Support::V2beta::FeedItem>
Pass arguments to show_feed via a request object, either of type ShowFeedRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Support::V2beta::ShowFeedRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def show_feed(parent: nil, order_by: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Support::V2beta::FeedItem>
Pass arguments to show_feed via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The resource name of the case for which feed items should be listed.
  • order_by (::String) — Optional. Field to order feed items by, followed by asc or desc postfix. The only valid field is creation_time. This list is case-insensitive, default sorting order is ascending, and the redundant space characters are insignificant.

    Example: creation_time desc

  • page_size (::Integer) — Optional. The maximum number of feed items fetched with each request.
  • page_token (::String) — Optional. A token identifying the page of results to return. If unspecified, it retrieves the first page.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/support/v2beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Support::V2beta::FeedService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Support::V2beta::ShowFeedRequest.new

# Call the show_feed method.
result = client.show_feed request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Support::V2beta::FeedItem.
  p item
end

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)