Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::SecuritySettingsService::Client (v0.10.2)

Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::SecuritySettingsService::Client.

Client for the SecuritySettingsService service.

Service for managing security settings for Dialogflow.

Inherits

Object

Includes

Google::Cloud::Dialogflow::CX::V3::SecuritySettingsService::Paths

Methods

.configure

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

Configure the SecuritySettingsService Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

# Modify the configuration for all SecuritySettingsService clients
::Google::Cloud::Dialogflow::CX::V3::SecuritySettingsService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

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

Configure the SecuritySettingsService 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

config (Client::Configuration)

Returns

(Client::Configuration)

#create_security_settings

def create_security_settings(request, options = nil) -> ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings
def create_security_settings(parent: nil, security_settings: nil) -> ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings

Create security settings in the specified location.

Overloads

def create_security_settings(request, options = nil) -> ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings

Pass arguments to create_security_settings via a request object, either of type CreateSecuritySettingsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Dialogflow::CX::V3::CreateSecuritySettingsRequest, ::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 create_security_settings(parent: nil, security_settings: nil) -> ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings

Pass arguments to create_security_settings 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 location to create an SecuritySettings for. Format: projects/<Project ID>/locations/<Location ID>.
security_settings (::Google::Cloud::Dialogflow::CX::V3::SecuritySettings, ::Hash) — Required. The security settings to create.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Dialogflow::CX::V3::SecuritySettings)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Dialogflow::CX::V3::SecuritySettings)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

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::SecuritySettingsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::CX::V3::CreateSecuritySettingsRequest.new

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

# The returned object is of type Google::Cloud::Dialogflow::CX::V3::SecuritySettings.
p result

#delete_security_settings

def delete_security_settings(request, options = nil) -> ::Google::Protobuf::Empty
def delete_security_settings(name: nil) -> ::Google::Protobuf::Empty

Deletes the specified SecuritySettings.

Overloads

def delete_security_settings(request, options = nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_security_settings via a request object, either of type DeleteSecuritySettingsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Dialogflow::CX::V3::DeleteSecuritySettingsRequest, ::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 delete_security_settings(name: nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_security_settings 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).

Parameter

name (::String) — Required. The name of the SecuritySettings to delete. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Protobuf::Empty)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

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::SecuritySettingsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::CX::V3::DeleteSecuritySettingsRequest.new

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

# The returned object is of type Google::Protobuf::Empty.
p result

#get_security_settings

def get_security_settings(request, options = nil) -> ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings
def get_security_settings(name: nil) -> ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings

Retrieves the specified SecuritySettings. The returned settings may be stale by up to 1 minute.

Overloads

def get_security_settings(request, options = nil) -> ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings

Pass arguments to get_security_settings via a request object, either of type GetSecuritySettingsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Dialogflow::CX::V3::GetSecuritySettingsRequest, ::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_security_settings(name: nil) -> ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings

Pass arguments to get_security_settings 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).

Parameter

name (::String) — Required. Resource name of the settings. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<security settings ID>.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Dialogflow::CX::V3::SecuritySettings)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Dialogflow::CX::V3::SecuritySettings)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

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::SecuritySettingsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::CX::V3::GetSecuritySettingsRequest.new

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

# The returned object is of type Google::Cloud::Dialogflow::CX::V3::SecuritySettings.
p result

#initialize

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

Create a new SecuritySettingsService client object.

Yields

(config) — Configure the SecuritySettingsService client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::Dialogflow::CX::V3::SecuritySettingsService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Dialogflow::CX::V3::SecuritySettingsService::Client.new do |config|
  config.timeout = 10.0
end

#list_security_settings

def list_security_settings(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::SecuritySettings>
def list_security_settings(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::SecuritySettings>

Returns the list of all security settings in the specified location.

Overloads

def list_security_settings(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::SecuritySettings>

Pass arguments to list_security_settings via a request object, either of type ListSecuritySettingsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Dialogflow::CX::V3::ListSecuritySettingsRequest, ::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_security_settings(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::SecuritySettings>

Pass arguments to list_security_settings 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 location to list all security settings for. Format: projects/<Project ID>/locations/<Location ID>.
page_size (::Integer) — The maximum number of items to return in a single page. By default 20 and at most 100.
page_token (::String) — The next_page_token value returned from a previous list request.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::SecuritySettings>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::SecuritySettings>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

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::SecuritySettingsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::CX::V3::ListSecuritySettingsRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings.
  p response
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

Get the associated client for mix-in of the Locations.

Returns

(Google::Cloud::Location::Locations::Client)

#update_security_settings

def update_security_settings(request, options = nil) -> ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings
def update_security_settings(security_settings: nil, update_mask: nil) -> ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings

Updates the specified SecuritySettings.

Overloads

def update_security_settings(request, options = nil) -> ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings

Pass arguments to update_security_settings via a request object, either of type UpdateSecuritySettingsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Dialogflow::CX::V3::UpdateSecuritySettingsRequest, ::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 update_security_settings(security_settings: nil, update_mask: nil) -> ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings

Pass arguments to update_security_settings 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

security_settings (::Google::Cloud::Dialogflow::CX::V3::SecuritySettings, ::Hash) — Required. [SecuritySettings] object that contains values for each of the fields to update.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. The mask to control which fields get updated. If the mask is not present, all fields will be updated.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Dialogflow::CX::V3::SecuritySettings)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Dialogflow::CX::V3::SecuritySettings)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

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::SecuritySettingsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::CX::V3::UpdateSecuritySettingsRequest.new

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

# The returned object is of type Google::Cloud::Dialogflow::CX::V3::SecuritySettings.
p result