Class: Google::Cloud::Datastream::V1alpha1::Datastream::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/datastream/v1alpha1/datastream/client.rb

Overview

Client for the Datastream service.

Datastream service

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#connection_profile_path, #location_path, #private_connection_path, #route_path, #stream_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new Datastream client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Datastream::V1alpha1::Datastream::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Datastream::V1alpha1::Datastream::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Datastream client.

Yield Parameters:



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/google/cloud/datastream/v1alpha1/datastream/client.rb', line 146

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/datastream/v1alpha1/datastream_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @datastream_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Datastream::V1alpha1::Datastream::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool
  )
end

Instance Attribute Details

#operations_client ⇒ ::Google::Cloud::Datastream::V1alpha1::Datastream::Operations (readonly)

Get the associated client for long-running operations.

Returns:



198
199
200
 
# File 'lib/google/cloud/datastream/v1alpha1/datastream/client.rb', line 198

def operations_client
  @operations_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the Datastream Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all Datastream clients
::Google::Cloud::Datastream::V1alpha1::Datastream::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/google/cloud/datastream/v1alpha1/datastream/client.rb', line 59

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Datastream", "V1alpha1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.timeout = 60.0
    default_config.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.create_connection_profile.timeout = 60.0

    default_config.rpcs.update_connection_profile.timeout = 60.0

    default_config.rpcs.delete_connection_profile.timeout = 60.0

    default_config.rpcs.create_stream.timeout = 60.0

    default_config.rpcs.update_stream.timeout = 60.0

    default_config.rpcs.delete_stream.timeout = 60.0

    default_config.rpcs.create_private_connection.timeout = 60.0

    default_config.rpcs.delete_private_connection.timeout = 60.0

    default_config.rpcs.create_route.timeout = 60.0

    default_config.rpcs.delete_route.timeout = 60.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

Configure the Datastream 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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



116
117
118
119
 
# File 'lib/google/cloud/datastream/v1alpha1/datastream/client.rb', line 116

def configure
  yield @config if block_given?
  @config
end

#create_connection_profile(request, options = nil) ⇒ ::Gapic::Operation #create_connection_profile(parent: nil, connection_profile_id: nil, connection_profile: nil, request_id: nil) ⇒ ::Gapic::Operation

Use this method to create a connection profile in a project and location.

Examples:

Basic example

require "google/cloud/datastream/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Datastream::V1alpha1::Datastream::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Datastream::V1alpha1::CreateConnectionProfileRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #create_connection_profile(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::Datastream::V1alpha1::CreateConnectionProfileRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_connection_profile(parent: nil, connection_profile_id: nil, connection_profile: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_connection_profile 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) (defaults to: nil) —

      Required. The parent that owns the collection of ConnectionProfiles.

    • connection_profile_id (::String) (defaults to: nil) —

      Required. The connection profile identifier.

    • connection_profile (::Google::Cloud::Datastream::V1alpha1::ConnectionProfile, ::Hash) (defaults to: nil) —

      Required. The connection profile resource to create.

    • request_id (::String) (defaults to: nil) —

      Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/google/cloud/datastream/v1alpha1/datastream/client.rb', line 461

def create_connection_profile request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1alpha1::CreateConnectionProfileRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_connection_profile.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Datastream::V1alpha1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_connection_profile.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_connection_profile.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @datastream_stub.call_rpc :create_connection_profile, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_private_connection(request, options = nil) ⇒ ::Gapic::Operation #create_private_connection(parent: nil, private_connection_id: nil, private_connection: nil, request_id: nil) ⇒ ::Gapic::Operation

Use this method to create a private connectivity configuration.

Examples:

Basic example

require "google/cloud/datastream/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Datastream::V1alpha1::Datastream::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Datastream::V1alpha1::CreatePrivateConnectionRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #create_private_connection(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::Datastream::V1alpha1::CreatePrivateConnectionRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_private_connection(parent: nil, private_connection_id: nil, private_connection: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_private_connection 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) (defaults to: nil) —

      Required. The parent that owns the collection of PrivateConnections.

    • private_connection_id (::String) (defaults to: nil) —

      Required. The private connectivity identifier.

    • private_connection (::Google::Cloud::Datastream::V1alpha1::PrivateConnection, ::Hash) (defaults to: nil) —

      Required. The Private Connectivity resource to create.

    • request_id (::String) (defaults to: nil) —

      Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
 
# File 'lib/google/cloud/datastream/v1alpha1/datastream/client.rb', line 1610

def create_private_connection request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1alpha1::CreatePrivateConnectionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_private_connection.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Datastream::V1alpha1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_private_connection.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_private_connection.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @datastream_stub.call_rpc :create_private_connection, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_route(request, options = nil) ⇒ ::Gapic::Operation #create_route(parent: nil, route_id: nil, route: nil, request_id: nil) ⇒ ::Gapic::Operation

Use this method to create a route for a private connectivity in a project and location.

Examples:

Basic example

require "google/cloud/datastream/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Datastream::V1alpha1::Datastream::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Datastream::V1alpha1::CreateRouteRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #create_route(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::Datastream::V1alpha1::CreateRouteRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_route(parent: nil, route_id: nil, route: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_route 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) (defaults to: nil) —

      Required. The parent that owns the collection of Routes.

    • route_id (::String) (defaults to: nil) —

      Required. The Route identifier.

    • route (::Google::Cloud::Datastream::V1alpha1::Route, ::Hash) (defaults to: nil) —

      Required. The Route resource to create.

    • request_id (::String) (defaults to: nil) —

      Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
 
# File 'lib/google/cloud/datastream/v1alpha1/datastream/client.rb', line 2024

def create_route request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1alpha1::CreateRouteRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_route.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Datastream::V1alpha1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_route.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_route.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @datastream_stub.call_rpc :create_route, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_stream(request, options = nil) ⇒ ::Gapic::Operation #create_stream(parent: nil, stream_id: nil, stream: nil, request_id: nil, validate_only: nil, force: nil) ⇒ ::Gapic::Operation

Use this method to create a stream.

Examples:

Basic example

require "google/cloud/datastream/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Datastream::V1alpha1::Datastream::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Datastream::V1alpha1::CreateStreamRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #create_stream(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::Datastream::V1alpha1::CreateStreamRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_stream(parent: nil, stream_id: nil, stream: nil, request_id: nil, validate_only: nil, force: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_stream 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) (defaults to: nil) —

      Required. The parent that owns the collection of streams.

    • stream_id (::String) (defaults to: nil) —

      Required. The stream identifier.

    • stream (::Google::Cloud::Datastream::V1alpha1::Stream, ::Hash) (defaults to: nil) —

      Required. The stream resource to create.

    • request_id (::String) (defaults to: nil) —

      Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

    • validate_only (::Boolean) (defaults to: nil) —

      Optional. Only validate the stream, but do not create any resources. The default is false.

    • force (::Boolean) (defaults to: nil) —

      Optional. Create the stream without validating it.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
 
# File 'lib/google/cloud/datastream/v1alpha1/datastream/client.rb', line 1088

def create_stream request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1alpha1::CreateStreamRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_stream.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Datastream::V1alpha1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_stream.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_stream.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @datastream_stub.call_rpc :create_stream, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_connection_profile(request, options = nil) ⇒ ::Gapic::Operation #delete_connection_profile(name: nil, request_id: nil) ⇒ ::Gapic::Operation

Use this method to delete a connection profile..

Examples:

Basic example

require "google/cloud/datastream/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Datastream::V1alpha1::Datastream::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Datastream::V1alpha1::DeleteConnectionProfileRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #delete_connection_profile(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_connection_profile via a request object, either of type Google::Cloud::Datastream::V1alpha1::DeleteConnectionProfileRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Datastream::V1alpha1::DeleteConnectionProfileRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_connection_profile(name: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_connection_profile 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:

    • name (::String) (defaults to: nil) —

      Required. The name of the connection profile resource to delete.

    • request_id (::String) (defaults to: nil) —

      Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
 
# File 'lib/google/cloud/datastream/v1alpha1/datastream/client.rb', line 681

def delete_connection_profile request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1alpha1::DeleteConnectionProfileRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_connection_profile.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Datastream::V1alpha1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_connection_profile.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_connection_profile.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @datastream_stub.call_rpc :delete_connection_profile, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_private_connection(request, options = nil) ⇒ ::Gapic::Operation #delete_private_connection(name: nil, request_id: nil, force: nil) ⇒ ::Gapic::Operation

Use this method to delete a private connectivity configuration.

Examples:

Basic example

require "google/cloud/datastream/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Datastream::V1alpha1::Datastream::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Datastream::V1alpha1::DeletePrivateConnectionRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #delete_private_connection(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_private_connection via a request object, either of type Google::Cloud::Datastream::V1alpha1::DeletePrivateConnectionRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Datastream::V1alpha1::DeletePrivateConnectionRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_private_connection(name: nil, request_id: nil, force: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_private_connection 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:

    • name (::String) (defaults to: nil) —

      Required. The name of the private connectivity configuration to delete.

    • request_id (::String) (defaults to: nil) —

      Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

    • force (::Boolean) (defaults to: nil) —

      Optional. If set to true, any child routes that belong to this PrivateConnection will also be deleted.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
 
# File 'lib/google/cloud/datastream/v1alpha1/datastream/client.rb', line 1912

def delete_private_connection request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1alpha1::DeletePrivateConnectionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_private_connection.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Datastream::V1alpha1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_private_connection.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_private_connection.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @datastream_stub.call_rpc :delete_private_connection, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_route(request, options = nil) ⇒ ::Gapic::Operation #delete_route(name: nil, request_id: nil) ⇒ ::Gapic::Operation

Use this method to delete a route.

Examples:

Basic example

require "google/cloud/datastream/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Datastream::V1alpha1::Datastream::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Datastream::V1alpha1::DeleteRouteRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #delete_route(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_route via a request object, either of type Google::Cloud::Datastream::V1alpha1::DeleteRouteRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Datastream::V1alpha1::DeleteRouteRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_route(name: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_route 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:

    • name (::String) (defaults to: nil) —

      Required. The name of the Route resource to delete.

    • request_id (::String) (defaults to: nil) —

      Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
 
# File 'lib/google/cloud/datastream/v1alpha1/datastream/client.rb', line 2323

def delete_route request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1alpha1::DeleteRouteRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_route.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Datastream::V1alpha1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_route.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_route.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @datastream_stub.call_rpc :delete_route, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_stream(request, options = nil) ⇒ ::Gapic::Operation #delete_stream(name: nil, request_id: nil) ⇒ ::Gapic::Operation

Use this method to delete a stream.

Examples:

Basic example

require "google/cloud/datastream/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Datastream::V1alpha1::Datastream::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Datastream::V1alpha1::DeleteStreamRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #delete_stream(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_stream via a request object, either of type Google::Cloud::Datastream::V1alpha1::DeleteStreamRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Datastream::V1alpha1::DeleteStreamRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_stream(name: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_stream 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:

    • name (::String) (defaults to: nil) —

      Required. The name of the stream resource to delete.

    • request_id (::String) (defaults to: nil) —

      Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
 
# File 'lib/google/cloud/datastream/v1alpha1/datastream/client.rb', line 1313

def delete_stream request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1alpha1::DeleteStreamRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_stream.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Datastream::V1alpha1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_stream.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_stream.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @datastream_stub.call_rpc :delete_stream, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#discover_connection_profile(request, options = nil) ⇒ ::Google::Cloud::Datastream::V1alpha1::DiscoverConnectionProfileResponse #discover_connection_profile(parent: nil, connection_profile: nil, connection_profile_name: nil, recursive: nil, recursion_depth: nil, oracle_rdbms: nil, mysql_rdbms: nil) ⇒ ::Google::Cloud::Datastream::V1alpha1::DiscoverConnectionProfileResponse

Use this method to discover a connection profile. The discover API call exposes the data objects and metadata belonging to the profile. Typically, a request returns children data objects under a parent data object that's optionally supplied in the request.

Examples:

Basic example

require "google/cloud/datastream/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Datastream::V1alpha1::Datastream::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Datastream::V1alpha1::DiscoverConnectionProfileRequest.new

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

# The returned object is of type Google::Cloud::Datastream::V1alpha1::DiscoverConnectionProfileResponse.
p result

Overloads:

  • #discover_connection_profile(request, options = nil) ⇒ ::Google::Cloud::Datastream::V1alpha1::DiscoverConnectionProfileResponse

    Pass arguments to discover_connection_profile via a request object, either of type Google::Cloud::Datastream::V1alpha1::DiscoverConnectionProfileRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Datastream::V1alpha1::DiscoverConnectionProfileRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #discover_connection_profile(parent: nil, connection_profile: nil, connection_profile_name: nil, recursive: nil, recursion_depth: nil, oracle_rdbms: nil, mysql_rdbms: nil) ⇒ ::Google::Cloud::Datastream::V1alpha1::DiscoverConnectionProfileResponse

    Pass arguments to discover_connection_profile 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) (defaults to: nil) —

      Required. The parent resource of the ConnectionProfile type. Must be in the format projects/*/locations/*.

    • connection_profile (::Google::Cloud::Datastream::V1alpha1::ConnectionProfile, ::Hash) (defaults to: nil) —

      An ad-hoc ConnectionProfile configuration.

    • connection_profile_name (::String) (defaults to: nil) —

      A reference to an existing ConnectionProfile.

    • recursive (::Boolean) (defaults to: nil) —

      Whether to retrieve the full hierarchy of data objects (TRUE) or only the current level (FALSE).

    • recursion_depth (::Integer) (defaults to: nil) —

      The number of hierarchy levels below the current level to be retrieved.

    • oracle_rdbms (::Google::Cloud::Datastream::V1alpha1::OracleRdbms, ::Hash) (defaults to: nil) —

      Oracle RDBMS to enrich with child data objects and metadata.

    • mysql_rdbms (::Google::Cloud::Datastream::V1alpha1::MysqlRdbms, ::Hash) (defaults to: nil) —

      MySQL RDBMS to enrich with child data objects and metadata.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'lib/google/cloud/datastream/v1alpha1/datastream/client.rb', line 784

def discover_connection_profile request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1alpha1::DiscoverConnectionProfileRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.discover_connection_profile.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Datastream::V1alpha1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.discover_connection_profile.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.discover_connection_profile.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @datastream_stub.call_rpc :discover_connection_profile, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#fetch_errors(request, options = nil) ⇒ ::Gapic::Operation #fetch_errors(stream: nil) ⇒ ::Gapic::Operation

Use this method to fetch any errors associated with a stream.

Examples:

Basic example

require "google/cloud/datastream/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Datastream::V1alpha1::Datastream::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Datastream::V1alpha1::FetchErrorsRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #fetch_errors(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::Datastream::V1alpha1::FetchErrorsRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #fetch_errors(stream: nil) ⇒ ::Gapic::Operation

    Pass arguments to fetch_errors 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:

    • stream (::String) (defaults to: nil) —

      Name of the Stream resource for which to fetch any errors.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
 
# File 'lib/google/cloud/datastream/v1alpha1/datastream/client.rb', line 1406

def fetch_errors request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1alpha1::FetchErrorsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.fetch_errors.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Datastream::V1alpha1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.stream
    header_params["stream"] = request.stream
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.fetch_errors.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.fetch_errors.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @datastream_stub.call_rpc :fetch_errors, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#fetch_static_ips(request, options = nil) ⇒ ::Google::Cloud::Datastream::V1alpha1::FetchStaticIpsResponse #fetch_static_ips(name: nil, page_size: nil, page_token: nil) ⇒ ::Google::Cloud::Datastream::V1alpha1::FetchStaticIpsResponse

The FetchStaticIps API call exposes the static ips used by Datastream. Typically, a request returns children data objects under a parent data object that's optionally supplied in the request.

Examples:

Basic example

require "google/cloud/datastream/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Datastream::V1alpha1::Datastream::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Datastream::V1alpha1::FetchStaticIpsRequest.new

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

# The returned object is of type Google::Cloud::Datastream::V1alpha1::FetchStaticIpsResponse.
p result

Overloads:

  • #fetch_static_ips(request, options = nil) ⇒ ::Google::Cloud::Datastream::V1alpha1::FetchStaticIpsResponse

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

    Parameters:

    • request (::Google::Cloud::Datastream::V1alpha1::FetchStaticIpsRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #fetch_static_ips(name: nil, page_size: nil, page_token: nil) ⇒ ::Google::Cloud::Datastream::V1alpha1::FetchStaticIpsResponse

    Pass arguments to fetch_static_ips 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:

    • name (::String) (defaults to: nil) —

      Required. The name resource of the Response type. Must be in the format projects/*/locations/*.

    • page_size (::Integer) (defaults to: nil) —

      Maximum number of Ips to return, will likely not be specified.

    • page_token (::String) (defaults to: nil) —

      A page token, received from a previous ListStaticIps call. will likely not be specified.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
 
# File 'lib/google/cloud/datastream/v1alpha1/datastream/client.rb', line 1500

def fetch_static_ips request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1alpha1::FetchStaticIpsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.fetch_static_ips.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Datastream::V1alpha1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.fetch_static_ips.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.fetch_static_ips.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @datastream_stub.call_rpc :fetch_static_ips, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_connection_profile(request, options = nil) ⇒ ::Google::Cloud::Datastream::V1alpha1::ConnectionProfile #get_connection_profile(name: nil) ⇒ ::Google::Cloud::Datastream::V1alpha1::ConnectionProfile

Use this method to get details about a connection profile.

Examples:

Basic example

require "google/cloud/datastream/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Datastream::V1alpha1::Datastream::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Datastream::V1alpha1::GetConnectionProfileRequest.new

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

# The returned object is of type Google::Cloud::Datastream::V1alpha1::ConnectionProfile.
p result

Overloads:

  • #get_connection_profile(request, options = nil) ⇒ ::Google::Cloud::Datastream::V1alpha1::ConnectionProfile

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

    Parameters:

    • request (::Google::Cloud::Datastream::V1alpha1::GetConnectionProfileRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_connection_profile(name: nil) ⇒ ::Google::Cloud::Datastream::V1alpha1::ConnectionProfile

    Pass arguments to get_connection_profile 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:

    • name (::String) (defaults to: nil) —

      Required. The name of the connection profile resource to get.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/google/cloud/datastream/v1alpha1/datastream/client.rb', line 351

def get_connection_profile request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1alpha1::GetConnectionProfileRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_connection_profile.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Datastream::V1alpha1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_connection_profile.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_connection_profile.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @datastream_stub.call_rpc :get_connection_profile, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_private_connection(request, options = nil) ⇒ ::Google::Cloud::Datastream::V1alpha1::PrivateConnection #get_private_connection(name: nil) ⇒ ::Google::Cloud::Datastream::V1alpha1::PrivateConnection

Use this method to get details about a private connectivity configuration.

Examples:

Basic example

require "google/cloud/datastream/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Datastream::V1alpha1::Datastream::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Datastream::V1alpha1::GetPrivateConnectionRequest.new

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

# The returned object is of type Google::Cloud::Datastream::V1alpha1::PrivateConnection.
p result

Overloads:

  • #get_private_connection(request, options = nil) ⇒ ::Google::Cloud::Datastream::V1alpha1::PrivateConnection

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

    Parameters:

    • request (::Google::Cloud::Datastream::V1alpha1::GetPrivateConnectionRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_private_connection(name: nil) ⇒ ::Google::Cloud::Datastream::V1alpha1::PrivateConnection

    Pass arguments to get_private_connection 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:

    • name (::String) (defaults to: nil) —

      Required. The name of the private connectivity configuration to get.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
 
# File 'lib/google/cloud/datastream/v1alpha1/datastream/client.rb', line 1696

def get_private_connection request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1alpha1::GetPrivateConnectionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_private_connection.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Datastream::V1alpha1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_private_connection.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_private_connection.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @datastream_stub.call_rpc :get_private_connection, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_route(request, options = nil) ⇒ ::Google::Cloud::Datastream::V1alpha1::Route #get_route(name: nil) ⇒ ::Google::Cloud::Datastream::V1alpha1::Route

Use this method to get details about a route.

Examples:

Basic example

require "google/cloud/datastream/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Datastream::V1alpha1::Datastream::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Datastream::V1alpha1::GetRouteRequest.new

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

# The returned object is of type Google::Cloud::Datastream::V1alpha1::Route.
p result

Overloads:

  • #get_route(request, options = nil) ⇒ ::Google::Cloud::Datastream::V1alpha1::Route

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

    Parameters:

    • request (::Google::Cloud::Datastream::V1alpha1::GetRouteRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_route(name: nil) ⇒ ::Google::Cloud::Datastream::V1alpha1::Route

    Pass arguments to get_route 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:

    • name (::String) (defaults to: nil) —

      Required. The name of the Route resource to get.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
 
# File 'lib/google/cloud/datastream/v1alpha1/datastream/client.rb', line 2110

def get_route request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1alpha1::GetRouteRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_route.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Datastream::V1alpha1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_route.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_route.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @datastream_stub.call_rpc :get_route, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_stream(request, options = nil) ⇒ ::Google::Cloud::Datastream::V1alpha1::Stream #get_stream(name: nil) ⇒ ::Google::Cloud::Datastream::V1alpha1::Stream

Use this method to get details about a stream.

Examples:

Basic example

require "google/cloud/datastream/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Datastream::V1alpha1::Datastream::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Datastream::V1alpha1::GetStreamRequest.new

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

# The returned object is of type Google::Cloud::Datastream::V1alpha1::Stream.
p result

Overloads:

  • #get_stream(request, options = nil) ⇒ ::Google::Cloud::Datastream::V1alpha1::Stream

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

    Parameters:

    • request (::Google::Cloud::Datastream::V1alpha1::GetStreamRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_stream(name: nil) ⇒ ::Google::Cloud::Datastream::V1alpha1::Stream

    Pass arguments to get_stream 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:

    • name (::String) (defaults to: nil) —

      Required. The name of the stream resource to get.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
 
# File 'lib/google/cloud/datastream/v1alpha1/datastream/client.rb', line 973

def get_stream request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1alpha1::GetStreamRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_stream.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Datastream::V1alpha1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_stream.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_stream.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @datastream_stub.call_rpc :get_stream, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_connection_profiles(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Datastream::V1alpha1::ConnectionProfile> #list_connection_profiles(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Datastream::V1alpha1::ConnectionProfile>

Use this method to list connection profiles created in a project and location.

Examples:

Basic example

require "google/cloud/datastream/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Datastream::V1alpha1::Datastream::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Datastream::V1alpha1::ListConnectionProfilesRequest.new

# Call the list_connection_profiles method.
result = client.list_connection_profiles 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::Datastream::V1alpha1::ConnectionProfile.
  p item
end

Overloads:

  • #list_connection_profiles(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Datastream::V1alpha1::ConnectionProfile>

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

    Parameters:

    • request (::Google::Cloud::Datastream::V1alpha1::ListConnectionProfilesRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_connection_profiles(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Datastream::V1alpha1::ConnectionProfile>

    Pass arguments to list_connection_profiles 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) (defaults to: nil) —

      Required. The parent that owns the collection of connection profiles.

    • page_size (::Integer) (defaults to: nil) —

      Maximum number of connection profiles to return. If unspecified, at most 50 connection profiles will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

    • page_token (::String) (defaults to: nil) —

      Page token received from a previous ListConnectionProfiles call. Provide this to retrieve the subsequent page.

      When paginating, all other parameters provided to ListConnectionProfiles must match the call that provided the page token.

    • filter (::String) (defaults to: nil) —

      Filter request.

    • order_by (::String) (defaults to: nil) —

      Order by fields for the result.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/google/cloud/datastream/v1alpha1/datastream/client.rb', line 265

def list_connection_profiles request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1alpha1::ListConnectionProfilesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_connection_profiles.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Datastream::V1alpha1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_connection_profiles.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_connection_profiles.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @datastream_stub.call_rpc :list_connection_profiles, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @datastream_stub, :list_connection_profiles, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_private_connections(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Datastream::V1alpha1::PrivateConnection> #list_private_connections(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Datastream::V1alpha1::PrivateConnection>

Use this method to list private connectivity configurations in a project and location.

Examples:

Basic example

require "google/cloud/datastream/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Datastream::V1alpha1::Datastream::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Datastream::V1alpha1::ListPrivateConnectionsRequest.new

# Call the list_private_connections method.
result = client.list_private_connections 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::Datastream::V1alpha1::PrivateConnection.
  p item
end

Overloads:

  • #list_private_connections(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Datastream::V1alpha1::PrivateConnection>

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

    Parameters:

    • request (::Google::Cloud::Datastream::V1alpha1::ListPrivateConnectionsRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_private_connections(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Datastream::V1alpha1::PrivateConnection>

    Pass arguments to list_private_connections 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) (defaults to: nil) —

      Required. The parent that owns the collection of private connectivity configurations.

    • page_size (::Integer) (defaults to: nil) —

      Maximum number of private connectivity configurations to return. If unspecified, at most 50 private connectivity configurations that will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

    • page_token (::String) (defaults to: nil) —

      Page token received from a previous ListPrivateConnections call. Provide this to retrieve the subsequent page.

      When paginating, all other parameters provided to ListPrivateConnections must match the call that provided the page token.

    • filter (::String) (defaults to: nil) —

      Filter request.

    • order_by (::String) (defaults to: nil) —

      Order by fields for the result.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
 
# File 'lib/google/cloud/datastream/v1alpha1/datastream/client.rb', line 1802

def list_private_connections request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1alpha1::ListPrivateConnectionsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_private_connections.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Datastream::V1alpha1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_private_connections.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_private_connections.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @datastream_stub.call_rpc :list_private_connections, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @datastream_stub, :list_private_connections, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_routes(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Datastream::V1alpha1::Route> #list_routes(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Datastream::V1alpha1::Route>

Use this method to list routes created for a private connectivity in a project and location.

Examples:

Basic example

require "google/cloud/datastream/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Datastream::V1alpha1::Datastream::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Datastream::V1alpha1::ListRoutesRequest.new

# Call the list_routes method.
result = client.list_routes 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::Datastream::V1alpha1::Route.
  p item
end

Overloads:

  • #list_routes(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Datastream::V1alpha1::Route>

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

    Parameters:

    • request (::Google::Cloud::Datastream::V1alpha1::ListRoutesRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_routes(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Datastream::V1alpha1::Route>

    Pass arguments to list_routes 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) (defaults to: nil) —

      Required. The parent that owns the collection of Routess.

    • page_size (::Integer) (defaults to: nil) —

      Maximum number of Routes to return. The service may return fewer than this value. If unspecified, at most 50 Routes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

    • page_token (::String) (defaults to: nil) —

      Page token received from a previous ListRoutes call. Provide this to retrieve the subsequent page.

      When paginating, all other parameters provided to ListRoutes must match the call that provided the page token.

    • filter (::String) (defaults to: nil) —

      Filter request.

    • order_by (::String) (defaults to: nil) —

      Order by fields for the result.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
 
# File 'lib/google/cloud/datastream/v1alpha1/datastream/client.rb', line 2216

def list_routes request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1alpha1::ListRoutesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_routes.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Datastream::V1alpha1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_routes.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_routes.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @datastream_stub.call_rpc :list_routes, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @datastream_stub, :list_routes, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_streams(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Datastream::V1alpha1::Stream> #list_streams(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Datastream::V1alpha1::Stream>

Use this method to list streams in a project and location.

Examples:

Basic example

require "google/cloud/datastream/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Datastream::V1alpha1::Datastream::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Datastream::V1alpha1::ListStreamsRequest.new

# Call the list_streams method.
result = client.list_streams 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::Datastream::V1alpha1::Stream.
  p item
end

Overloads:

  • #list_streams(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Datastream::V1alpha1::Stream>

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

    Parameters:

    • request (::Google::Cloud::Datastream::V1alpha1::ListStreamsRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_streams(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Datastream::V1alpha1::Stream>

    Pass arguments to list_streams 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) (defaults to: nil) —

      Required. The parent that owns the collection of streams.

    • page_size (::Integer) (defaults to: nil) —

      Maximum number of streams to return. If unspecified, at most 50 streams will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

    • page_token (::String) (defaults to: nil) —

      Page token received from a previous ListStreams call. Provide this to retrieve the subsequent page.

      When paginating, all other parameters provided to ListStreams must match the call that provided the page token.

    • filter (::String) (defaults to: nil) —

      Filter request.

    • order_by (::String) (defaults to: nil) —

      Order by fields for the result.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
 
# File 'lib/google/cloud/datastream/v1alpha1/datastream/client.rb', line 887

def list_streams request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1alpha1::ListStreamsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_streams.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Datastream::V1alpha1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_streams.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_streams.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @datastream_stub.call_rpc :list_streams, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @datastream_stub, :list_streams, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


126
127
128
 
# File 'lib/google/cloud/datastream/v1alpha1/datastream/client.rb', line 126

def universe_domain
  @datastream_stub.universe_domain
end

#update_connection_profile(request, options = nil) ⇒ ::Gapic::Operation #update_connection_profile(update_mask: nil, connection_profile: nil, request_id: nil) ⇒ ::Gapic::Operation

Use this method to update the parameters of a connection profile.

Examples:

Basic example

require "google/cloud/datastream/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Datastream::V1alpha1::Datastream::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Datastream::V1alpha1::UpdateConnectionProfileRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #update_connection_profile(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::Datastream::V1alpha1::UpdateConnectionProfileRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_connection_profile(update_mask: nil, connection_profile: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to update_connection_profile 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:

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Optional. Field mask is used to specify the fields to be overwritten in the ConnectionProfile resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

    • connection_profile (::Google::Cloud::Datastream::V1alpha1::ConnectionProfile, ::Hash) (defaults to: nil) —

      Required. The ConnectionProfile to update.

    • request_id (::String) (defaults to: nil) —

      Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
 
# File 'lib/google/cloud/datastream/v1alpha1/datastream/client.rb', line 574

def update_connection_profile request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1alpha1::UpdateConnectionProfileRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_connection_profile.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Datastream::V1alpha1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.connection_profile&.name
    header_params["connection_profile.name"] = request.connection_profile.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_connection_profile.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_connection_profile.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @datastream_stub.call_rpc :update_connection_profile, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_stream(request, options = nil) ⇒ ::Gapic::Operation #update_stream(update_mask: nil, stream: nil, request_id: nil, validate_only: nil, force: nil) ⇒ ::Gapic::Operation

Use this method to update the configuration of a stream.

Examples:

Basic example

require "google/cloud/datastream/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Datastream::V1alpha1::Datastream::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Datastream::V1alpha1::UpdateStreamRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #update_stream(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::Datastream::V1alpha1::UpdateStreamRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_stream(update_mask: nil, stream: nil, request_id: nil, validate_only: nil, force: nil) ⇒ ::Gapic::Operation

    Pass arguments to update_stream 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:

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Optional. Field mask is used to specify the fields to be overwritten in the stream resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

    • stream (::Google::Cloud::Datastream::V1alpha1::Stream, ::Hash) (defaults to: nil) —

      Required. The stream resource to update.

    • request_id (::String) (defaults to: nil) —

      Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

    • validate_only (::Boolean) (defaults to: nil) —

      Optional. Only validate the stream with the changes, without actually updating it. The default is false.

    • force (::Boolean) (defaults to: nil) —

      Optional. Execute the update without validating it.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
 
# File 'lib/google/cloud/datastream/v1alpha1/datastream/client.rb', line 1206

def update_stream request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1alpha1::UpdateStreamRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_stream.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Datastream::V1alpha1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.stream&.name
    header_params["stream.name"] = request.stream.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_stream.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_stream.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @datastream_stub.call_rpc :update_stream, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end