class Google::Apis::DatastreamV1alpha1::DatastreamService

Datastream API

@example

require 'google/apis/datastream_v1alpha1'

Datastream = Google::Apis::DatastreamV1alpha1 # Alias the module
service = Datastream::DatastreamService.new

@see cloud.google.com/datastream/

Attributes

key[RW]

@return [String]

API key. Your API key identifies your project and provides you with API access,
quota, and reports. Required unless you provide an OAuth 2.0 token.
quota_user[RW]

@return [String]

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

Public Class Methods

new() click to toggle source
Calls superclass method
# File lib/google/apis/datastream_v1alpha1/service.rb, line 45
def initialize
  super('https://datastream.googleapis.com/', '',
        client_name: 'google-apis-datastream_v1alpha1',
        client_version: Google::Apis::DatastreamV1alpha1::GEM_VERSION)
  @batch_path = 'batch'
end

Public Instance Methods

cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns ‘google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. @param [String] name

The name of the operation resource to be cancelled.

@param [Google::Apis::DatastreamV1alpha1::CancelOperationRequest] cancel_operation_request_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DatastreamV1alpha1::Empty] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DatastreamV1alpha1::Empty]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/datastream_v1alpha1/service.rb, line 451
def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha1/{+name}:cancel', options)
  command.request_representation = Google::Apis::DatastreamV1alpha1::CancelOperationRequest::Representation
  command.request_object = cancel_operation_request_object
  command.response_representation = Google::Apis::DatastreamV1alpha1::Empty::Representation
  command.response_class = Google::Apis::DatastreamV1alpha1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
create_project_location_connection_profile(parent, connection_profile_object = nil, connection_profile_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Use this method to create a connection profile in a project and location. @param [String] parent

Required. The parent that owns the collection of ConnectionProfiles.

@param [Google::Apis::DatastreamV1alpha1::ConnectionProfile] connection_profile_object @param [String] connection_profile_id

Required. The connection profile identifier.

@param [String] request_id

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).

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DatastreamV1alpha1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DatastreamV1alpha1::Operation]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/datastream_v1alpha1/service.rb, line 197
def create_project_location_connection_profile(parent, connection_profile_object = nil, connection_profile_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha1/{+parent}/connectionProfiles', options)
  command.request_representation = Google::Apis::DatastreamV1alpha1::ConnectionProfile::Representation
  command.request_object = connection_profile_object
  command.response_representation = Google::Apis::DatastreamV1alpha1::Operation::Representation
  command.response_class = Google::Apis::DatastreamV1alpha1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['connectionProfileId'] = connection_profile_id unless connection_profile_id.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
create_project_location_private_connection(parent, private_connection_object = nil, private_connection_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Use this method to create a private connectivity configuration. @param [String] parent

Required. The parent that owns the collection of PrivateConnections.

@param [Google::Apis::DatastreamV1alpha1::PrivateConnection] private_connection_object @param [String] private_connection_id

Required. The private connectivity identifier.

@param [String] request_id

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).

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DatastreamV1alpha1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DatastreamV1alpha1::Operation]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/datastream_v1alpha1/service.rb, line 607
def create_project_location_private_connection(parent, private_connection_object = nil, private_connection_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha1/{+parent}/privateConnections', options)
  command.request_representation = Google::Apis::DatastreamV1alpha1::PrivateConnection::Representation
  command.request_object = private_connection_object
  command.response_representation = Google::Apis::DatastreamV1alpha1::Operation::Representation
  command.response_class = Google::Apis::DatastreamV1alpha1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['privateConnectionId'] = private_connection_id unless private_connection_id.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
create_project_location_private_connection_route(parent, route_object = nil, request_id: nil, route_id: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Use this method to create a route for a private connectivity in a project and location. @param [String] parent

Required. The parent that owns the collection of Routes.

@param [Google::Apis::DatastreamV1alpha1::Route] route_object @param [String] request_id

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).

@param [String] route_id

Required. The Route identifier.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DatastreamV1alpha1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DatastreamV1alpha1::Operation]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/datastream_v1alpha1/service.rb, line 781
def create_project_location_private_connection_route(parent, route_object = nil, request_id: nil, route_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha1/{+parent}/routes', options)
  command.request_representation = Google::Apis::DatastreamV1alpha1::Route::Representation
  command.request_object = route_object
  command.response_representation = Google::Apis::DatastreamV1alpha1::Operation::Representation
  command.response_class = Google::Apis::DatastreamV1alpha1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['routeId'] = route_id unless route_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
create_project_location_stream(parent, stream_object = nil, force: nil, request_id: nil, stream_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Use this method to create a stream. @param [String] parent

Required. The parent that owns the collection of streams.

@param [Google::Apis::DatastreamV1alpha1::Stream] stream_object @param [Boolean] force

Optional. Create the stream without validating it.

@param [String] request_id

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).

@param [String] stream_id

Required. The stream identifier.

@param [Boolean] validate_only

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

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DatastreamV1alpha1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DatastreamV1alpha1::Operation]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/datastream_v1alpha1/service.rb, line 953
def create_project_location_stream(parent, stream_object = nil, force: nil, request_id: nil, stream_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha1/{+parent}/streams', options)
  command.request_representation = Google::Apis::DatastreamV1alpha1::Stream::Representation
  command.request_object = stream_object
  command.response_representation = Google::Apis::DatastreamV1alpha1::Operation::Representation
  command.response_class = Google::Apis::DatastreamV1alpha1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['force'] = force unless force.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['streamId'] = stream_id unless stream_id.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
delete_project_location_connection_profile(name, request_id: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Use this method to delete a connection profile.. @param [String] name

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

@param [String] request_id

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).

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DatastreamV1alpha1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DatastreamV1alpha1::Operation]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/datastream_v1alpha1/service.rb, line 242
def delete_project_location_connection_profile(name, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::DatastreamV1alpha1::Operation::Representation
  command.response_class = Google::Apis::DatastreamV1alpha1::Operation
  command.params['name'] = name unless name.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn’t support this method, it returns ‘google.rpc.Code. UNIMPLEMENTED`. @param [String] name

The name of the operation resource to be deleted.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DatastreamV1alpha1::Empty] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DatastreamV1alpha1::Empty]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/datastream_v1alpha1/service.rb, line 486
def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::DatastreamV1alpha1::Empty::Representation
  command.response_class = Google::Apis::DatastreamV1alpha1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
delete_project_location_private_connection(name, force: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Use this method to delete a private connectivity configuration. @param [String] name

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

@param [Boolean] force

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

@param [String] request_id

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).

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DatastreamV1alpha1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DatastreamV1alpha1::Operation]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/datastream_v1alpha1/service.rb, line 655
def delete_project_location_private_connection(name, force: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::DatastreamV1alpha1::Operation::Representation
  command.response_class = Google::Apis::DatastreamV1alpha1::Operation
  command.params['name'] = name unless name.nil?
  command.query['force'] = force unless force.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
delete_project_location_private_connection_route(name, request_id: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Use this method to delete a route. @param [String] name

Required. The name of the Route resource to delete.

@param [String] request_id

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).

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DatastreamV1alpha1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DatastreamV1alpha1::Operation]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/datastream_v1alpha1/service.rb, line 826
def delete_project_location_private_connection_route(name, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::DatastreamV1alpha1::Operation::Representation
  command.response_class = Google::Apis::DatastreamV1alpha1::Operation
  command.params['name'] = name unless name.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
delete_project_location_stream(name, request_id: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Use this method to delete a stream. @param [String] name

Required. The name of the stream resource to delete.

@param [String] request_id

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).

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DatastreamV1alpha1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DatastreamV1alpha1::Operation]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/datastream_v1alpha1/service.rb, line 1000
def delete_project_location_stream(name, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::DatastreamV1alpha1::Operation::Representation
  command.response_class = Google::Apis::DatastreamV1alpha1::Operation
  command.params['name'] = name unless name.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
discover_connection_profile(parent, discover_connection_profile_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

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. @param [String] parent

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

@param [Google::Apis::DatastreamV1alpha1::DiscoverConnectionProfileRequest] discover_connection_profile_request_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DatastreamV1alpha1::DiscoverConnectionProfileResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DatastreamV1alpha1::DiscoverConnectionProfileResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/datastream_v1alpha1/service.rb, line 278
def discover_connection_profile(parent, discover_connection_profile_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha1/{+parent}/connectionProfiles:discover', options)
  command.request_representation = Google::Apis::DatastreamV1alpha1::DiscoverConnectionProfileRequest::Representation
  command.request_object = discover_connection_profile_request_object
  command.response_representation = Google::Apis::DatastreamV1alpha1::DiscoverConnectionProfileResponse::Representation
  command.response_class = Google::Apis::DatastreamV1alpha1::DiscoverConnectionProfileResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
fetch_project_location_static_ips(name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

The FetchStaticIps API call exposes the static IP addresses used by Datastream. @param [String] name

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

@param [Fixnum] page_size

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

@param [String] page_token

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

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DatastreamV1alpha1::FetchStaticIpsResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DatastreamV1alpha1::FetchStaticIpsResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/datastream_v1alpha1/service.rb, line 78
def fetch_project_location_static_ips(name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+name}:fetchStaticIps', options)
  command.response_representation = Google::Apis::DatastreamV1alpha1::FetchStaticIpsResponse::Representation
  command.response_class = Google::Apis::DatastreamV1alpha1::FetchStaticIpsResponse
  command.params['name'] = name unless name.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
fetch_stream_errors(stream, fetch_errors_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Use this method to fetch any errors associated with a stream. @param [String] stream

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

@param [Google::Apis::DatastreamV1alpha1::FetchErrorsRequest] fetch_errors_request_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DatastreamV1alpha1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DatastreamV1alpha1::Operation]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/datastream_v1alpha1/service.rb, line 1032
def fetch_stream_errors(stream, fetch_errors_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha1/{+stream}:fetchErrors', options)
  command.request_representation = Google::Apis::DatastreamV1alpha1::FetchErrorsRequest::Representation
  command.request_object = fetch_errors_request_object
  command.response_representation = Google::Apis::DatastreamV1alpha1::Operation::Representation
  command.response_class = Google::Apis::DatastreamV1alpha1::Operation
  command.params['stream'] = stream unless stream.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
get_project_location(name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Gets information about a location. @param [String] name

Resource name for the location.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DatastreamV1alpha1::Location] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DatastreamV1alpha1::Location]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/datastream_v1alpha1/service.rb, line 110
def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::DatastreamV1alpha1::Location::Representation
  command.response_class = Google::Apis::DatastreamV1alpha1::Location
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
get_project_location_connection_profile(name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Use this method to get details about a connection profile. @param [String] name

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

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DatastreamV1alpha1::ConnectionProfile] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DatastreamV1alpha1::ConnectionProfile]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/datastream_v1alpha1/service.rb, line 310
def get_project_location_connection_profile(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::DatastreamV1alpha1::ConnectionProfile::Representation
  command.response_class = Google::Apis::DatastreamV1alpha1::ConnectionProfile
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. @param [String] name

The name of the operation resource.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DatastreamV1alpha1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DatastreamV1alpha1::Operation]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/datastream_v1alpha1/service.rb, line 517
def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::DatastreamV1alpha1::Operation::Representation
  command.response_class = Google::Apis::DatastreamV1alpha1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
get_project_location_private_connection(name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Use this method to get details about a private connectivity configuration. @param [String] name

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

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DatastreamV1alpha1::PrivateConnection] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DatastreamV1alpha1::PrivateConnection]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/datastream_v1alpha1/service.rb, line 687
def get_project_location_private_connection(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::DatastreamV1alpha1::PrivateConnection::Representation
  command.response_class = Google::Apis::DatastreamV1alpha1::PrivateConnection
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
get_project_location_private_connection_route(name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Use this method to get details about a route. @param [String] name

Required. The name of the Route resource to get.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DatastreamV1alpha1::Route] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DatastreamV1alpha1::Route]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/datastream_v1alpha1/service.rb, line 857
def get_project_location_private_connection_route(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::DatastreamV1alpha1::Route::Representation
  command.response_class = Google::Apis::DatastreamV1alpha1::Route
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
get_project_location_stream(name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Use this method to get details about a stream. @param [String] name

Required. The name of the stream resource to get.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DatastreamV1alpha1::Stream] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DatastreamV1alpha1::Stream]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/datastream_v1alpha1/service.rb, line 1064
def get_project_location_stream(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::DatastreamV1alpha1::Stream::Representation
  command.response_class = Google::Apis::DatastreamV1alpha1::Stream
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
get_project_location_stream_object(name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Use this method to get details about a stream object. @param [String] name

Required. The name of the stream object resource to get.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DatastreamV1alpha1::StreamObject] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DatastreamV1alpha1::StreamObject]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/datastream_v1alpha1/service.rb, line 1199
def get_project_location_stream_object(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::DatastreamV1alpha1::StreamObject::Representation
  command.response_class = Google::Apis::DatastreamV1alpha1::StreamObject
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
list_project_location_connection_profiles(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Use this method to list connection profiles created in a project and location. @param [String] parent

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

@param [String] filter

Filter request.

@param [String] order_by

Order by fields for the result.

@param [Fixnum] page_size

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.

@param [String] page_token

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.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DatastreamV1alpha1::ListConnectionProfilesResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DatastreamV1alpha1::ListConnectionProfilesResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/datastream_v1alpha1/service.rb, line 353
def list_project_location_connection_profiles(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+parent}/connectionProfiles', options)
  command.response_representation = Google::Apis::DatastreamV1alpha1::ListConnectionProfilesResponse::Representation
  command.response_class = Google::Apis::DatastreamV1alpha1::ListConnectionProfilesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Lists operations that match the specified filter in the request. If the server doesn’t support this method, it returns ‘UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `“/v1/`name=users/*`/operations”` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. @param [String] name

The name of the operation's parent resource.

@param [String] filter

The standard list filter.

@param [Fixnum] page_size

The standard list page size.

@param [String] page_token

The standard list page token.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DatastreamV1alpha1::ListOperationsResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DatastreamV1alpha1::ListOperationsResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/datastream_v1alpha1/service.rb, line 560
def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+name}/operations', options)
  command.response_representation = Google::Apis::DatastreamV1alpha1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::DatastreamV1alpha1::ListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
list_project_location_private_connection_routes(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Use this method to list routes created for a private connectivity in a project and location. @param [String] parent

Required. The parent that owns the collection of Routess.

@param [String] filter

Filter request.

@param [String] order_by

Order by fields for the result.

@param [Fixnum] page_size

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.

@param [String] page_token

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.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DatastreamV1alpha1::ListRoutesResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DatastreamV1alpha1::ListRoutesResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/datastream_v1alpha1/service.rb, line 900
def list_project_location_private_connection_routes(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+parent}/routes', options)
  command.response_representation = Google::Apis::DatastreamV1alpha1::ListRoutesResponse::Representation
  command.response_class = Google::Apis::DatastreamV1alpha1::ListRoutesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
list_project_location_private_connections(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Use this method to list private connectivity configurations in a project and location. @param [String] parent

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

@param [String] filter

Filter request.

@param [String] order_by

Order by fields for the result.

@param [Fixnum] page_size

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.

@param [String] page_token

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.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DatastreamV1alpha1::ListPrivateConnectionsResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DatastreamV1alpha1::ListPrivateConnectionsResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/datastream_v1alpha1/service.rb, line 732
def list_project_location_private_connections(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+parent}/privateConnections', options)
  command.response_representation = Google::Apis::DatastreamV1alpha1::ListPrivateConnectionsResponse::Representation
  command.response_class = Google::Apis::DatastreamV1alpha1::ListPrivateConnectionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
list_project_location_stream_objects(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Use this method to list the objects of a specific stream. @param [String] parent

Required. The parent stream that owns the collection of objects.

@param [Fixnum] page_size

Maximum number of objects to return. Default is 50. The maximum value is 1000;
values above 1000 will be coerced to 1000.

@param [String] page_token

Page token received from a previous `ListStreamObjectsRequest` call. Provide
this to retrieve the subsequent page. When paginating, all other parameters
provided to `ListStreamObjectsRequest` must match the call that provided the
page token.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DatastreamV1alpha1::ListStreamObjectsResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DatastreamV1alpha1::ListStreamObjectsResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/datastream_v1alpha1/service.rb, line 1237
def list_project_location_stream_objects(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+parent}/objects', options)
  command.response_representation = Google::Apis::DatastreamV1alpha1::ListStreamObjectsResponse::Representation
  command.response_class = Google::Apis::DatastreamV1alpha1::ListStreamObjectsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
list_project_location_streams(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Use this method to list streams in a project and location. @param [String] parent

Required. The parent that owns the collection of streams.

@param [String] filter

Filter request.

@param [String] order_by

Order by fields for the result.

@param [Fixnum] page_size

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.

@param [String] page_token

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.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DatastreamV1alpha1::ListStreamsResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DatastreamV1alpha1::ListStreamsResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/datastream_v1alpha1/service.rb, line 1106
def list_project_location_streams(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+parent}/streams', options)
  command.response_representation = Google::Apis::DatastreamV1alpha1::ListStreamsResponse::Representation
  command.response_class = Google::Apis::DatastreamV1alpha1::ListStreamsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Lists information about the supported locations for this service. @param [String] name

The resource that owns the locations collection, if applicable.

@param [String] filter

A filter to narrow down results to a preferred subset. The filtering language
accepts strings like `"displayName=tokyo"`, and is documented in more detail
in [AIP-160](https://google.aip.dev/160).

@param [Fixnum] page_size

The maximum number of results to return. If not set, the service selects a
default.

@param [String] page_token

A page token received from the `next_page_token` field in the response. Send
that page token to receive the subsequent page.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DatastreamV1alpha1::ListLocationsResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DatastreamV1alpha1::ListLocationsResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/datastream_v1alpha1/service.rb, line 150
def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+name}/locations', options)
  command.response_representation = Google::Apis::DatastreamV1alpha1::ListLocationsResponse::Representation
  command.response_class = Google::Apis::DatastreamV1alpha1::ListLocationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
patch_project_location_connection_profile(name, connection_profile_object = nil, request_id: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Use this method to update the parameters of a connection profile. @param [String] name

Output only. The resource's name.

@param [Google::Apis::DatastreamV1alpha1::ConnectionProfile] connection_profile_object @param [String] request_id

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).

@param [String] update_mask

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.

@param [Boolean] validate_only

Optional. Only validate the connection profile, but do not update any
resources. The default is false.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DatastreamV1alpha1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DatastreamV1alpha1::Operation]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/datastream_v1alpha1/service.rb, line 408
def patch_project_location_connection_profile(name, connection_profile_object = nil, request_id: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1alpha1/{+name}', options)
  command.request_representation = Google::Apis::DatastreamV1alpha1::ConnectionProfile::Representation
  command.request_object = connection_profile_object
  command.response_representation = Google::Apis::DatastreamV1alpha1::Operation::Representation
  command.response_class = Google::Apis::DatastreamV1alpha1::Operation
  command.params['name'] = name unless name.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
patch_project_location_stream(name, stream_object = nil, force: nil, request_id: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Use this method to update the configuration of a stream. @param [String] name

Output only. The stream's name.

@param [Google::Apis::DatastreamV1alpha1::Stream] stream_object @param [Boolean] force

Optional. Execute the update without validating it.

@param [String] request_id

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).

@param [String] update_mask

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.

@param [Boolean] validate_only

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

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DatastreamV1alpha1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DatastreamV1alpha1::Operation]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/datastream_v1alpha1/service.rb, line 1163
def patch_project_location_stream(name, stream_object = nil, force: nil, request_id: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1alpha1/{+name}', options)
  command.request_representation = Google::Apis::DatastreamV1alpha1::Stream::Representation
  command.request_object = stream_object
  command.response_representation = Google::Apis::DatastreamV1alpha1::Operation::Representation
  command.response_class = Google::Apis::DatastreamV1alpha1::Operation
  command.params['name'] = name unless name.nil?
  command.query['force'] = force unless force.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
start_project_location_stream_object_backfill_job(object, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Starts backfill job for the specified stream object. @param [String] object

Required. The name of the stream object resource to start a backfill job for.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DatastreamV1alpha1::StartBackfillJobResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DatastreamV1alpha1::StartBackfillJobResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/datastream_v1alpha1/service.rb, line 1269
def start_project_location_stream_object_backfill_job(object, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha1/{+object}:startBackfillJob', options)
  command.response_representation = Google::Apis::DatastreamV1alpha1::StartBackfillJobResponse::Representation
  command.response_class = Google::Apis::DatastreamV1alpha1::StartBackfillJobResponse
  command.params['object'] = object unless object.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
stop_project_location_stream_object_backfill_job(object, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Stops the backfill job for the specified stream object. @param [String] object

Required. The name of the stream object resource to stop the backfill job for.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DatastreamV1alpha1::StopBackfillJobResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DatastreamV1alpha1::StopBackfillJobResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/datastream_v1alpha1/service.rb, line 1299
def stop_project_location_stream_object_backfill_job(object, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha1/{+object}:stopBackfillJob', options)
  command.response_representation = Google::Apis::DatastreamV1alpha1::StopBackfillJobResponse::Representation
  command.response_class = Google::Apis::DatastreamV1alpha1::StopBackfillJobResponse
  command.params['object'] = object unless object.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

Protected Instance Methods

apply_command_defaults(command) click to toggle source
# File lib/google/apis/datastream_v1alpha1/service.rb, line 1311
def apply_command_defaults(command)
  command.query['key'] = key unless key.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
end