Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::Changelogs::Rest::Client.
REST client for the Changelogs service.
Service for managing Changelogs.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the Changelogs Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all Changelogs clients ::Google::Cloud::Dialogflow::CX::V3::Changelogs::Rest::Client.configure do |config| config.timeout = 10.0 end
#configure
def configure() { |config| ... } -> Client::Configuration
Configure the Changelogs 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.
- (config) — Configure the Client client.
- config (Client::Configuration)
#get_changelog
def get_changelog(request, options = nil) -> ::Google::Cloud::Dialogflow::CX::V3::Changelog
def get_changelog(name: nil) -> ::Google::Cloud::Dialogflow::CX::V3::Changelog
Retrieves the specified Changelog.
def get_changelog(request, options = nil) -> ::Google::Cloud::Dialogflow::CX::V3::Changelog
get_changelog
via a request object, either of type
GetChangelogRequest or an equivalent Hash.
- request (::Google::Cloud::Dialogflow::CX::V3::GetChangelogRequest, ::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 get_changelog(name: nil) -> ::Google::Cloud::Dialogflow::CX::V3::Changelog
get_changelog
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).
-
name (::String) — Required. The name of the changelog to get.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/changelogs/<ChangelogID>
.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Dialogflow::CX::V3::Changelog)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/dialogflow/cx/v3" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dialogflow::CX::V3::Changelogs::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dialogflow::CX::V3::GetChangelogRequest.new # Call the get_changelog method. result = client.get_changelog request # The returned object is of type Google::Cloud::Dialogflow::CX::V3::Changelog. p result
#initialize
def initialize() { |config| ... } -> Client
Create a new Changelogs REST client object.
- (config) — Configure the Changelogs client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::Dialogflow::CX::V3::Changelogs::Rest::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Dialogflow::CX::V3::Changelogs::Rest::Client.new do |config| config.timeout = 10.0 end
#list_changelogs
def list_changelogs(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::Changelog>
def list_changelogs(parent: nil, filter: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::Changelog>
Returns the list of Changelogs.
def list_changelogs(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::Changelog>
list_changelogs
via a request object, either of type
ListChangelogsRequest or an equivalent Hash.
- request (::Google::Cloud::Dialogflow::CX::V3::ListChangelogsRequest, ::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 list_changelogs(parent: nil, filter: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::Changelog>
list_changelogs
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).
-
parent (::String) — Required. The agent containing the changelogs.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>
. -
filter (::String) —
The filter string. Supports filter by user_email, resource, type and create_time. Some examples:
- By user email: user_email = "someone@google.com"
- By resource name: resource = "projects/123/locations/global/agents/456/flows/789"
- By resource display name: display_name = "my agent"
- By action: action = "Create"
- By type: type = "flows"
- By create time. Currently predicates on
create_time
andcreate_time_epoch_seconds
are supported: create_time_epoch_seconds > 1551790877 AND create_time <= 2017-01-15T01:30:15.01Z - Combination of above filters: resource = "projects/123/locations/global/agents/456/flows/789" AND user_email = "someone@google.com" AND create_time <= 2017-01-15T01:30:15.01Z
- page_size (::Integer) — The maximum number of items to return in a single page. By default 100 and at most 1000.
- page_token (::String) — The next_page_token value returned from a previous list request.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::Changelog>)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::Changelog>)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/dialogflow/cx/v3" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dialogflow::CX::V3::Changelogs::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dialogflow::CX::V3::ListChangelogsRequest.new # Call the list_changelogs method. result = client.list_changelogs 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::Dialogflow::CX::V3::Changelog. p item end
#location_client
def location_client() -> Google::Cloud::Location::Locations::Rest::Client
Get the associated client for mix-in of the Locations.
- (Google::Cloud::Location::Locations::Rest::Client)
#logger
def logger() -> Logger
The logger used for request/response debug logging.
- (Logger)
#universe_domain
def universe_domain() -> String
The effective universe domain
- (String)