Datastream service v1
Package
@google-cloud/datastreamConstructors
(constructor)(opts, gaxInstance)
constructor
(
opts
?:
ClientOptions
,
gaxInstance
?:
typeof
gax
|
typeof
gax
.
fallback
);
Construct an instance of DatastreamClient.
opts
ClientOptions
gaxInstance
typeof gax | typeof gax.fallback
: loaded instance of google-gax
. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new DatastreamClient({fallback: 'rest'}, gax); ```
Properties
apiEndpoint
static
get
apiEndpoint
()
:
string
;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
auth
:
gax
.
GoogleAuth
;
datastreamStub
datastreamStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
descriptors
descriptors
:
Descriptors
;
iamClient
iamClient
:
IamClient
;
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
locationsClient
locationsClient
:
LocationsClient
;
operationsClient
operationsClient
:
gax
.
OperationsClient
;
pathTemplates
pathTemplates
:
{
[
name
:
string
]
:
gax
.
PathTemplate
;
};
port
static
get
port
()
:
number
;
The port for this API service.
scopes
static
get
scopes
()
:
string
[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static
get
servicePath
()
:
string
;
The DNS address for this API service.
warn
warn
:
(
code
:
string
,
message
:
string
,
warnType
?:
string
)
=
>
void
;
Methods
cancelOperation(request, options, callback)
cancelOperation
(
request
:
protos
.
google
.
longrunning
.
CancelOperationRequest
,
options
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
longrunning
.
CancelOperationRequest
,
{}
|
undefined
|
null
> ,
callback
?:
Callback<protos
.
google
.
longrunning
.
CancelOperationRequest
,
protos
.
google
.
protobuf
.
Empty
,
{}
|
undefined
|
null
> )
:
Promise<protos
.
google
.
protobuf
.
Empty
> ;
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 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 value with a of 1, corresponding to Code.CANCELLED
.
request
protos. google.longrunning.CancelOperationRequest
The request object that will be sent.
options
gax. CallOptions
| Callback
<protos. google.protobuf.Empty
, protos. google.longrunning.CancelOperationRequest
, {} | undefined | null>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
<protos. google.longrunning.CancelOperationRequest
, protos. google.protobuf.Empty
, {} | undefined | null>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Promise
<protos. google.protobuf.Empty
>
const
client
=
longrunning
.
operationsClient
();
await
client
.
cancelOperation
({
name
:
''
});
checkCreateConnectionProfileProgress(name)
checkCreateConnectionProfileProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
datastream
.
v1
.
ConnectionProfile
,
protos
.
google
.
cloud
.
datastream
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by createConnectionProfile()
.
name
string
The operation name that will be passed.
Promise
< LROperation
<protos. google.cloud.datastream.v1.ConnectionProfile
, protos. google.cloud.datastream.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent that owns the collection of ConnectionProfiles.
*/
// const parent = 'abc123'
/**
* Required. The connection profile identifier.
*/
// const connectionProfileId = 'abc123'
/**
* Required. The connection profile resource to create.
*/
// const connectionProfile = {}
/**
* 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).
*/
// const requestId = 'abc123'
/**
* Optional. Only validate the connection profile, but don't create any resources.
* The default is false.
*/
// const validateOnly = true
/**
* Optional. Create the connection profile without validating it.
*/
// const force = true
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callCreateConnectionProfile
()
{
// Construct request
const
request
=
{
parent
,
connectionProfileId
,
connectionProfile
,
};
// Run request
const
[
operation
]
=
await
datastreamClient
.
createConnectionProfile
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callCreateConnectionProfile
();
checkCreatePrivateConnectionProgress(name)
checkCreatePrivateConnectionProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
datastream
.
v1
.
PrivateConnection
,
protos
.
google
.
cloud
.
datastream
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by createPrivateConnection()
.
name
string
The operation name that will be passed.
Promise
< LROperation
<protos. google.cloud.datastream.v1.PrivateConnection
, protos. google.cloud.datastream.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent that owns the collection of PrivateConnections.
*/
// const parent = 'abc123'
/**
* Required. The private connectivity identifier.
*/
// const privateConnectionId = 'abc123'
/**
* Required. The Private Connectivity resource to create.
*/
// const privateConnection = {}
/**
* 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).
*/
// const requestId = 'abc123'
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callCreatePrivateConnection
()
{
// Construct request
const
request
=
{
parent
,
privateConnectionId
,
privateConnection
,
};
// Run request
const
[
operation
]
=
await
datastreamClient
.
createPrivateConnection
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callCreatePrivateConnection
();
checkCreateRouteProgress(name)
checkCreateRouteProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
datastream
.
v1
.
Route
,
protos
.
google
.
cloud
.
datastream
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by createRoute()
.
name
string
The operation name that will be passed.
Promise
< LROperation
<protos. google.cloud.datastream.v1.Route
, protos. google.cloud.datastream.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent that owns the collection of Routes.
*/
// const parent = 'abc123'
/**
* Required. The Route identifier.
*/
// const routeId = 'abc123'
/**
* Required. The Route resource to create.
*/
// const route = {}
/**
* 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).
*/
// const requestId = 'abc123'
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callCreateRoute
()
{
// Construct request
const
request
=
{
parent
,
routeId
,
route
,
};
// Run request
const
[
operation
]
=
await
datastreamClient
.
createRoute
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callCreateRoute
();
checkCreateStreamProgress(name)
checkCreateStreamProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
datastream
.
v1
.
Stream
,
protos
.
google
.
cloud
.
datastream
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by createStream()
.
name
string
The operation name that will be passed.
Promise
< LROperation
<protos. google.cloud.datastream.v1.Stream
, protos. google.cloud.datastream.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent that owns the collection of streams.
*/
// const parent = 'abc123'
/**
* Required. The stream identifier.
*/
// const streamId = 'abc123'
/**
* Required. The stream resource to create.
*/
// const stream = {}
/**
* 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).
*/
// const requestId = 'abc123'
/**
* Optional. Only validate the stream, but don't create any resources.
* The default is false.
*/
// const validateOnly = true
/**
* Optional. Create the stream without validating it.
*/
// const force = true
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callCreateStream
()
{
// Construct request
const
request
=
{
parent
,
streamId
,
stream
,
};
// Run request
const
[
operation
]
=
await
datastreamClient
.
createStream
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callCreateStream
();
checkDeleteConnectionProfileProgress(name)
checkDeleteConnectionProfileProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
cloud
.
datastream
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by deleteConnectionProfile()
.
name
string
The operation name that will be passed.
Promise
< LROperation
<protos. google.protobuf.Empty
, protos. google.cloud.datastream.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the connection profile resource to delete.
*/
// const name = 'abc123'
/**
* 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).
*/
// const requestId = 'abc123'
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callDeleteConnectionProfile
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
datastreamClient
.
deleteConnectionProfile
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteConnectionProfile
();
checkDeletePrivateConnectionProgress(name)
checkDeletePrivateConnectionProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
cloud
.
datastream
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by deletePrivateConnection()
.
name
string
The operation name that will be passed.
Promise
< LROperation
<protos. google.protobuf.Empty
, protos. google.cloud.datastream.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the private connectivity configuration to delete.
*/
// const name = 'abc123'
/**
* 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).
*/
// const requestId = 'abc123'
/**
* Optional. If set to true, any child routes that belong to this PrivateConnection will
* also be deleted.
*/
// const force = true
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callDeletePrivateConnection
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
datastreamClient
.
deletePrivateConnection
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeletePrivateConnection
();
checkDeleteRouteProgress(name)
checkDeleteRouteProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
cloud
.
datastream
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by deleteRoute()
.
name
string
The operation name that will be passed.
Promise
< LROperation
<protos. google.protobuf.Empty
, protos. google.cloud.datastream.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the Route resource to delete.
*/
// const name = 'abc123'
/**
* 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).
*/
// const requestId = 'abc123'
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callDeleteRoute
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
datastreamClient
.
deleteRoute
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteRoute
();
checkDeleteStreamProgress(name)
checkDeleteStreamProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
cloud
.
datastream
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by deleteStream()
.
name
string
The operation name that will be passed.
Promise
< LROperation
<protos. google.protobuf.Empty
, protos. google.cloud.datastream.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the stream resource to delete.
*/
// const name = 'abc123'
/**
* 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).
*/
// const requestId = 'abc123'
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callDeleteStream
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
datastreamClient
.
deleteStream
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteStream
();
checkUpdateConnectionProfileProgress(name)
checkUpdateConnectionProfileProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
datastream
.
v1
.
ConnectionProfile
,
protos
.
google
.
cloud
.
datastream
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by updateConnectionProfile()
.
name
string
The operation name that will be passed.
Promise
< LROperation
<protos. google.cloud.datastream.v1.ConnectionProfile
, protos. google.cloud.datastream.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* 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.
*/
// const updateMask = {}
/**
* Required. The connection profile to update.
*/
// const connectionProfile = {}
/**
* 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).
*/
// const requestId = 'abc123'
/**
* Optional. Only validate the connection profile, but don't update any resources.
* The default is false.
*/
// const validateOnly = true
/**
* Optional. Update the connection profile without validating it.
*/
// const force = true
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callUpdateConnectionProfile
()
{
// Construct request
const
request
=
{
connectionProfile
,
};
// Run request
const
[
operation
]
=
await
datastreamClient
.
updateConnectionProfile
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callUpdateConnectionProfile
();
checkUpdateStreamProgress(name)
checkUpdateStreamProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
datastream
.
v1
.
Stream
,
protos
.
google
.
cloud
.
datastream
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by updateStream()
.
name
string
The operation name that will be passed.
Promise
< LROperation
<protos. google.cloud.datastream.v1.Stream
, protos. google.cloud.datastream.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* 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.
*/
// const updateMask = {}
/**
* Required. The stream resource to update.
*/
// const stream = {}
/**
* 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).
*/
// const requestId = 'abc123'
/**
* Optional. Only validate the stream with the changes, without actually updating it.
* The default is false.
*/
// const validateOnly = true
/**
* Optional. Update the stream without validating it.
*/
// const force = true
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callUpdateStream
()
{
// Construct request
const
request
=
{
stream
,
};
// Run request
const
[
operation
]
=
await
datastreamClient
.
updateStream
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callUpdateStream
();
close()
close
()
:
Promise<void>
;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Promise
<void>
{Promise} A promise that resolves when the client is closed.
connectionProfilePath(project, location, connectionProfile)
connectionProfilePath
(
project
:
string
,
location
:
string
,
connectionProfile
:
string
)
:
string
;
Return a fully-qualified connectionProfile resource name string.
project
string
location
string
connectionProfile
string
string
{string} Resource name string.
createConnectionProfile(request, options)
createConnectionProfile
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
ICreateConnectionProfileRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
datastream
.
v1
.
IConnectionProfile
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Use this method to create a connection profile in a project and location.
request
protos. google.cloud.datastream.v1.ICreateConnectionProfileRequest
The request object that will be sent.
options
Promise
<[ LROperation
<protos. google.cloud.datastream.v1.IConnectionProfile
, protos. google.cloud.datastream.v1.IOperationMetadata
>,
protos. google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent that owns the collection of ConnectionProfiles.
*/
// const parent = 'abc123'
/**
* Required. The connection profile identifier.
*/
// const connectionProfileId = 'abc123'
/**
* Required. The connection profile resource to create.
*/
// const connectionProfile = {}
/**
* 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).
*/
// const requestId = 'abc123'
/**
* Optional. Only validate the connection profile, but don't create any resources.
* The default is false.
*/
// const validateOnly = true
/**
* Optional. Create the connection profile without validating it.
*/
// const force = true
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callCreateConnectionProfile
()
{
// Construct request
const
request
=
{
parent
,
connectionProfileId
,
connectionProfile
,
};
// Run request
const
[
operation
]
=
await
datastreamClient
.
createConnectionProfile
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callCreateConnectionProfile
();
createConnectionProfile(request, options, callback)
createConnectionProfile
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
ICreateConnectionProfileRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
datastream
.
v1
.
IConnectionProfile
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.ICreateConnectionProfileRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.datastream.v1.IConnectionProfile
, protos. google.cloud.datastream.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
createConnectionProfile(request, callback)
createConnectionProfile
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
ICreateConnectionProfileRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
datastream
.
v1
.
IConnectionProfile
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.ICreateConnectionProfileRequest
callback
Callback
< LROperation
<protos. google.cloud.datastream.v1.IConnectionProfile
, protos. google.cloud.datastream.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
createPrivateConnection(request, options)
createPrivateConnection
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
ICreatePrivateConnectionRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
datastream
.
v1
.
IPrivateConnection
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Use this method to create a private connectivity configuration.
request
protos. google.cloud.datastream.v1.ICreatePrivateConnectionRequest
The request object that will be sent.
options
Promise
<[ LROperation
<protos. google.cloud.datastream.v1.IPrivateConnection
, protos. google.cloud.datastream.v1.IOperationMetadata
>,
protos. google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent that owns the collection of PrivateConnections.
*/
// const parent = 'abc123'
/**
* Required. The private connectivity identifier.
*/
// const privateConnectionId = 'abc123'
/**
* Required. The Private Connectivity resource to create.
*/
// const privateConnection = {}
/**
* 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).
*/
// const requestId = 'abc123'
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callCreatePrivateConnection
()
{
// Construct request
const
request
=
{
parent
,
privateConnectionId
,
privateConnection
,
};
// Run request
const
[
operation
]
=
await
datastreamClient
.
createPrivateConnection
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callCreatePrivateConnection
();
createPrivateConnection(request, options, callback)
createPrivateConnection
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
ICreatePrivateConnectionRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
datastream
.
v1
.
IPrivateConnection
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.ICreatePrivateConnectionRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.datastream.v1.IPrivateConnection
, protos. google.cloud.datastream.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
createPrivateConnection(request, callback)
createPrivateConnection
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
ICreatePrivateConnectionRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
datastream
.
v1
.
IPrivateConnection
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.ICreatePrivateConnectionRequest
callback
Callback
< LROperation
<protos. google.cloud.datastream.v1.IPrivateConnection
, protos. google.cloud.datastream.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
createRoute(request, options)
createRoute
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
ICreateRouteRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
datastream
.
v1
.
IRoute
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Use this method to create a route for a private connectivity configuration in a project and location.
request
protos. google.cloud.datastream.v1.ICreateRouteRequest
The request object that will be sent.
options
Promise
<[ LROperation
<protos. google.cloud.datastream.v1.IRoute
, protos. google.cloud.datastream.v1.IOperationMetadata
>,
protos. google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent that owns the collection of Routes.
*/
// const parent = 'abc123'
/**
* Required. The Route identifier.
*/
// const routeId = 'abc123'
/**
* Required. The Route resource to create.
*/
// const route = {}
/**
* 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).
*/
// const requestId = 'abc123'
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callCreateRoute
()
{
// Construct request
const
request
=
{
parent
,
routeId
,
route
,
};
// Run request
const
[
operation
]
=
await
datastreamClient
.
createRoute
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callCreateRoute
();
createRoute(request, options, callback)
createRoute
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
ICreateRouteRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
datastream
.
v1
.
IRoute
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.ICreateRouteRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.datastream.v1.IRoute
, protos. google.cloud.datastream.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
createRoute(request, callback)
createRoute
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
ICreateRouteRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
datastream
.
v1
.
IRoute
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.ICreateRouteRequest
callback
Callback
< LROperation
<protos. google.cloud.datastream.v1.IRoute
, protos. google.cloud.datastream.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
createStream(request, options)
createStream
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
ICreateStreamRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
datastream
.
v1
.
IStream
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Use this method to create a stream.
request
protos. google.cloud.datastream.v1.ICreateStreamRequest
The request object that will be sent.
options
Promise
<[ LROperation
<protos. google.cloud.datastream.v1.IStream
, protos. google.cloud.datastream.v1.IOperationMetadata
>,
protos. google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent that owns the collection of streams.
*/
// const parent = 'abc123'
/**
* Required. The stream identifier.
*/
// const streamId = 'abc123'
/**
* Required. The stream resource to create.
*/
// const stream = {}
/**
* 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).
*/
// const requestId = 'abc123'
/**
* Optional. Only validate the stream, but don't create any resources.
* The default is false.
*/
// const validateOnly = true
/**
* Optional. Create the stream without validating it.
*/
// const force = true
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callCreateStream
()
{
// Construct request
const
request
=
{
parent
,
streamId
,
stream
,
};
// Run request
const
[
operation
]
=
await
datastreamClient
.
createStream
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callCreateStream
();
createStream(request, options, callback)
createStream
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
ICreateStreamRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
datastream
.
v1
.
IStream
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.ICreateStreamRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.datastream.v1.IStream
, protos. google.cloud.datastream.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
createStream(request, callback)
createStream
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
ICreateStreamRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
datastream
.
v1
.
IStream
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.ICreateStreamRequest
callback
Callback
< LROperation
<protos. google.cloud.datastream.v1.IStream
, protos. google.cloud.datastream.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deleteConnectionProfile(request, options)
deleteConnectionProfile
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IDeleteConnectionProfileRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Use this method to delete a connection profile.
request
protos. google.cloud.datastream.v1.IDeleteConnectionProfileRequest
The request object that will be sent.
options
Promise
<[ LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.datastream.v1.IOperationMetadata
>,
protos. google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the connection profile resource to delete.
*/
// const name = 'abc123'
/**
* 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).
*/
// const requestId = 'abc123'
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callDeleteConnectionProfile
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
datastreamClient
.
deleteConnectionProfile
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteConnectionProfile
();
deleteConnectionProfile(request, options, callback)
deleteConnectionProfile
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IDeleteConnectionProfileRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.IDeleteConnectionProfileRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.datastream.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deleteConnectionProfile(request, callback)
deleteConnectionProfile
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IDeleteConnectionProfileRequest
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.IDeleteConnectionProfileRequest
callback
Callback
< LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.datastream.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deleteOperation(request, options, callback)
deleteOperation
(
request
:
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
options
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
{}
|
null
|
undefined
> )
:
Promise<protos
.
google
.
protobuf
.
Empty
> ;
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
.
request
protos. google.longrunning.DeleteOperationRequest
The request object that will be sent.
options
gax. CallOptions
| Callback
<protos. google.protobuf.Empty
, protos. google.longrunning.DeleteOperationRequest
, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
<protos. google.protobuf.Empty
, protos. google.longrunning.DeleteOperationRequest
, {} | null | undefined>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Promise
<protos. google.protobuf.Empty
>
const
client
=
longrunning
.
operationsClient
();
await
client
.
deleteOperation
({
name
:
''
});
deletePrivateConnection(request, options)
deletePrivateConnection
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IDeletePrivateConnectionRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Use this method to delete a private connectivity configuration.
request
protos. google.cloud.datastream.v1.IDeletePrivateConnectionRequest
The request object that will be sent.
options
Promise
<[ LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.datastream.v1.IOperationMetadata
>,
protos. google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the private connectivity configuration to delete.
*/
// const name = 'abc123'
/**
* 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).
*/
// const requestId = 'abc123'
/**
* Optional. If set to true, any child routes that belong to this PrivateConnection will
* also be deleted.
*/
// const force = true
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callDeletePrivateConnection
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
datastreamClient
.
deletePrivateConnection
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeletePrivateConnection
();
deletePrivateConnection(request, options, callback)
deletePrivateConnection
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IDeletePrivateConnectionRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.IDeletePrivateConnectionRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.datastream.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deletePrivateConnection(request, callback)
deletePrivateConnection
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IDeletePrivateConnectionRequest
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.IDeletePrivateConnectionRequest
callback
Callback
< LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.datastream.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deleteRoute(request, options)
deleteRoute
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IDeleteRouteRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Use this method to delete a route.
request
protos. google.cloud.datastream.v1.IDeleteRouteRequest
The request object that will be sent.
options
Promise
<[ LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.datastream.v1.IOperationMetadata
>,
protos. google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the Route resource to delete.
*/
// const name = 'abc123'
/**
* 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).
*/
// const requestId = 'abc123'
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callDeleteRoute
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
datastreamClient
.
deleteRoute
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteRoute
();
deleteRoute(request, options, callback)
deleteRoute
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IDeleteRouteRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.IDeleteRouteRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.datastream.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deleteRoute(request, callback)
deleteRoute
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IDeleteRouteRequest
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.IDeleteRouteRequest
callback
Callback
< LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.datastream.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deleteStream(request, options)
deleteStream
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IDeleteStreamRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Use this method to delete a stream.
request
protos. google.cloud.datastream.v1.IDeleteStreamRequest
The request object that will be sent.
options
Promise
<[ LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.datastream.v1.IOperationMetadata
>,
protos. google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the stream resource to delete.
*/
// const name = 'abc123'
/**
* 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).
*/
// const requestId = 'abc123'
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callDeleteStream
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
datastreamClient
.
deleteStream
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteStream
();
deleteStream(request, options, callback)
deleteStream
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IDeleteStreamRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.IDeleteStreamRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.datastream.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deleteStream(request, callback)
deleteStream
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IDeleteStreamRequest
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.IDeleteStreamRequest
callback
Callback
< LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.datastream.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
discoverConnectionProfile(request, options)
discoverConnectionProfile
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IDiscoverConnectionProfileRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datastream
.
v1
.
IDiscoverConnectionProfileResponse
,
(
protos
.
google
.
cloud
.
datastream
.
v1
.
IDiscoverConnectionProfileRequest
|
undefined
),
{}
|
undefined
]>;
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 of a parent data object that's optionally supplied in the request.
request
protos. google.cloud.datastream.v1.IDiscoverConnectionProfileRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.datastream.v1.IDiscoverConnectionProfileResponse
,
(protos. google.cloud.datastream.v1.IDiscoverConnectionProfileRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent resource of the connection profile type. Must be in the
* format `projects/* /locations/*`.
*/
// const parent = 'abc123'
/**
* An ad-hoc connection profile configuration.
*/
// const connectionProfile = {}
/**
* A reference to an existing connection profile.
*/
// const connectionProfileName = 'abc123'
/**
* Whether to retrieve the full hierarchy of data objects (TRUE) or only the
* current level (FALSE).
*/
// const fullHierarchy = true
/**
* The number of hierarchy levels below the current level to be retrieved.
*/
// const hierarchyDepth = 1234
/**
* Oracle RDBMS to enrich with child data objects and metadata.
*/
// const oracleRdbms = {}
/**
* MySQL RDBMS to enrich with child data objects and metadata.
*/
// const mysqlRdbms = {}
/**
* PostgreSQL RDBMS to enrich with child data objects and metadata.
*/
// const postgresqlRdbms = {}
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callDiscoverConnectionProfile
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
response
=
await
datastreamClient
.
discoverConnectionProfile
(
request
);
console
.
log
(
response
);
}
callDiscoverConnectionProfile
();
discoverConnectionProfile(request, options, callback)
discoverConnectionProfile
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IDiscoverConnectionProfileRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datastream
.
v1
.
IDiscoverConnectionProfileResponse
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IDiscoverConnectionProfileRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.IDiscoverConnectionProfileRequest
options
CallOptions
callback
Callback
<protos. google.cloud.datastream.v1.IDiscoverConnectionProfileResponse
, protos. google.cloud.datastream.v1.IDiscoverConnectionProfileRequest
| null | undefined, {} | null | undefined>
void
discoverConnectionProfile(request, callback)
discoverConnectionProfile
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IDiscoverConnectionProfileRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
datastream
.
v1
.
IDiscoverConnectionProfileResponse
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IDiscoverConnectionProfileRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.IDiscoverConnectionProfileRequest
callback
Callback
<protos. google.cloud.datastream.v1.IDiscoverConnectionProfileResponse
, protos. google.cloud.datastream.v1.IDiscoverConnectionProfileRequest
| null | undefined, {} | null | undefined>
void
fetchStaticIps(request, options)
fetchStaticIps
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IFetchStaticIpsRequest
,
options
?:
CallOptions
)
:
Promise
< [
string
[],
protos
.
google
.
cloud
.
datastream
.
v1
.
IFetchStaticIpsRequest
|
null
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IFetchStaticIpsResponse
]>;
The FetchStaticIps API call exposes the static IP addresses used by Datastream.
request
protos. google.cloud.datastream.v1.IFetchStaticIpsRequest
The request object that will be sent.
options
Promise
<[
string[],
protos. google.cloud.datastream.v1.IFetchStaticIpsRequest
| null,
protos. google.cloud.datastream.v1.IFetchStaticIpsResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of string. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using fetchStaticIpsAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
fetchStaticIps(request, options, callback)
fetchStaticIps
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IFetchStaticIpsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datastream
.
v1
.
IFetchStaticIpsRequest
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IFetchStaticIpsResponse
|
null
|
undefined
,
string
> )
:
void
;
request
protos. google.cloud.datastream.v1.IFetchStaticIpsRequest
options
CallOptions
callback
PaginationCallback
<protos. google.cloud.datastream.v1.IFetchStaticIpsRequest
, protos. google.cloud.datastream.v1.IFetchStaticIpsResponse
| null | undefined, string>
void
fetchStaticIps(request, callback)
fetchStaticIps
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IFetchStaticIpsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datastream
.
v1
.
IFetchStaticIpsRequest
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IFetchStaticIpsResponse
|
null
|
undefined
,
string
> )
:
void
;
request
protos. google.cloud.datastream.v1.IFetchStaticIpsRequest
callback
PaginationCallback
<protos. google.cloud.datastream.v1.IFetchStaticIpsRequest
, protos. google.cloud.datastream.v1.IFetchStaticIpsResponse
| null | undefined, string>
void
fetchStaticIpsAsync(request, options)
fetchStaticIpsAsync
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IFetchStaticIpsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<string>
;
Equivalent to fetchStaticIps
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
protos. google.cloud.datastream.v1.IFetchStaticIpsRequest
The request object that will be sent.
options
AsyncIterable
<string>
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing string. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name for the location for which static IPs should be returned.
* Must be in the format `projects/* /locations/*`.
*/
// const name = 'abc123'
/**
* Maximum number of Ips to return, will likely not be specified.
*/
// const pageSize = 1234
/**
* A page token, received from a previous `ListStaticIps` call.
* will likely not be specified.
*/
// const pageToken = 'abc123'
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callFetchStaticIps
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
iterable
=
await
datastreamClient
.
fetchStaticIpsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callFetchStaticIps
();
fetchStaticIpsStream(request, options)
fetchStaticIpsStream
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IFetchStaticIpsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
request
protos. google.cloud.datastream.v1.IFetchStaticIpsRequest
The request object that will be sent.
options
Transform
{Stream} An object stream which emits an object representing string on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using fetchStaticIpsAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
getConnectionProfile(request, options)
getConnectionProfile
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IGetConnectionProfileRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datastream
.
v1
.
IConnectionProfile
,
(
protos
.
google
.
cloud
.
datastream
.
v1
.
IGetConnectionProfileRequest
|
undefined
),
{}
|
undefined
]>;
Use this method to get details about a connection profile.
request
protos. google.cloud.datastream.v1.IGetConnectionProfileRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.datastream.v1.IConnectionProfile
,
(protos. google.cloud.datastream.v1.IGetConnectionProfileRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the connection profile resource to get.
*/
// const name = 'abc123'
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callGetConnectionProfile
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
datastreamClient
.
getConnectionProfile
(
request
);
console
.
log
(
response
);
}
callGetConnectionProfile
();
getConnectionProfile(request, options, callback)
getConnectionProfile
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IGetConnectionProfileRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datastream
.
v1
.
IConnectionProfile
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IGetConnectionProfileRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.IGetConnectionProfileRequest
options
CallOptions
callback
Callback
<protos. google.cloud.datastream.v1.IConnectionProfile
, protos. google.cloud.datastream.v1.IGetConnectionProfileRequest
| null | undefined, {} | null | undefined>
void
getConnectionProfile(request, callback)
getConnectionProfile
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IGetConnectionProfileRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
datastream
.
v1
.
IConnectionProfile
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IGetConnectionProfileRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.IGetConnectionProfileRequest
callback
Callback
<protos. google.cloud.datastream.v1.IConnectionProfile
, protos. google.cloud.datastream.v1.IGetConnectionProfileRequest
| null | undefined, {} | null | undefined>
void
getIamPolicy(request, options, callback)
getIamPolicy
(
request
:
IamProtos
.
google
.
iam
.
v1
.
GetIamPolicyRequest
,
options
?:
gax
.
CallOptions
|
Callback<IamProtos
.
google
.
iam
.
v1
.
Policy
,
IamProtos
.
google
.
iam
.
v1
.
GetIamPolicyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<IamProtos
.
google
.
iam
.
v1
.
Policy
,
IamProtos
.
google
.
iam
.
v1
.
GetIamPolicyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
Promise<IamProtos
.
google
.
iam
.
v1
.
Policy
> ;
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
request
IamProtos. google.iam.v1.GetIamPolicyRequest
The request object that will be sent.
options
gax. CallOptions
| Callback
<IamProtos. google.iam.v1.Policy
, IamProtos. google.iam.v1.GetIamPolicyRequest
| null | undefined, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
<IamProtos. google.iam.v1.Policy
, IamProtos. google.iam.v1.GetIamPolicyRequest
| null | undefined, {} | null | undefined>
The function which will be called with the result of the API call.
The second parameter to the callback is an object representing .
Promise
<IamProtos. google.iam.v1.Policy
>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.
getLocation(request, options, callback)
getLocation
(
request
:
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
,
options
?:
gax
.
CallOptions
|
Callback<LocationProtos
.
google
.
cloud
.
location
.
ILocation
,
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<LocationProtos
.
google
.
cloud
.
location
.
ILocation
,
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
Promise<LocationProtos
.
google
.
cloud
.
location
.
ILocation
> ;
Gets information about a location.
request
LocationProtos. google.cloud.location.IGetLocationRequest
The request object that will be sent.
options
gax. CallOptions
| Callback
<LocationProtos. google.cloud.location.ILocation
, LocationProtos. google.cloud.location.IGetLocationRequest
| null | undefined, {} | null | undefined>
Call options. See CallOptions for more details.
callback
Callback
<LocationProtos. google.cloud.location.ILocation
, LocationProtos. google.cloud.location.IGetLocationRequest
| null | undefined, {} | null | undefined>
Promise
<LocationProtos. google.cloud.location.ILocation
>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
const
[
response
]
=
await
client
.
getLocation
(
request
);
getOperation(request, options, callback)
getOperation
(
request
:
protos
.
google
.
longrunning
.
GetOperationRequest
,
options
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
longrunning
.
Operation
,
protos
.
google
.
longrunning
.
GetOperationRequest
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<protos
.
google
.
longrunning
.
Operation
,
protos
.
google
.
longrunning
.
GetOperationRequest
,
{}
|
null
|
undefined
> )
:
Promise
< [
protos
.
google
.
longrunning
.
Operation
]>;
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.
request
protos. google.longrunning.GetOperationRequest
The request object that will be sent.
options
gax. CallOptions
| Callback
<protos. google.longrunning.Operation
, protos. google.longrunning.GetOperationRequest
, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
<protos. google.longrunning.Operation
, protos. google.longrunning.GetOperationRequest
, {} | null | undefined>
The function which will be called with the result of the API call.
The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.
Promise
<[protos. google.longrunning.Operation
]>
const
client
=
longrunning
.
operationsClient
();
const
name
=
''
;
const
[
response
]
=
await
client
.
getOperation
({
name
});
// doThingsWith(response)
getPrivateConnection(request, options)
getPrivateConnection
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IGetPrivateConnectionRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datastream
.
v1
.
IPrivateConnection
,
(
protos
.
google
.
cloud
.
datastream
.
v1
.
IGetPrivateConnectionRequest
|
undefined
),
{}
|
undefined
]>;
Use this method to get details about a private connectivity configuration.
request
protos. google.cloud.datastream.v1.IGetPrivateConnectionRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.datastream.v1.IPrivateConnection
,
(protos. google.cloud.datastream.v1.IGetPrivateConnectionRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the private connectivity configuration to get.
*/
// const name = 'abc123'
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callGetPrivateConnection
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
datastreamClient
.
getPrivateConnection
(
request
);
console
.
log
(
response
);
}
callGetPrivateConnection
();
getPrivateConnection(request, options, callback)
getPrivateConnection
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IGetPrivateConnectionRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datastream
.
v1
.
IPrivateConnection
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IGetPrivateConnectionRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.IGetPrivateConnectionRequest
options
CallOptions
callback
Callback
<protos. google.cloud.datastream.v1.IPrivateConnection
, protos. google.cloud.datastream.v1.IGetPrivateConnectionRequest
| null | undefined, {} | null | undefined>
void
getPrivateConnection(request, callback)
getPrivateConnection
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IGetPrivateConnectionRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
datastream
.
v1
.
IPrivateConnection
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IGetPrivateConnectionRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.IGetPrivateConnectionRequest
callback
Callback
<protos. google.cloud.datastream.v1.IPrivateConnection
, protos. google.cloud.datastream.v1.IGetPrivateConnectionRequest
| null | undefined, {} | null | undefined>
void
getProjectId()
getProjectId
()
:
Promise<string>
;
Promise
<string>
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
callback
Callback
<string, undefined, undefined>
void
getRoute(request, options)
getRoute
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IGetRouteRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datastream
.
v1
.
IRoute
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IGetRouteRequest
|
undefined
,
{}
|
undefined
]>;
Use this method to get details about a route.
request
protos. google.cloud.datastream.v1.IGetRouteRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.datastream.v1.IRoute
,
protos. google.cloud.datastream.v1.IGetRouteRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the Route resource to get.
*/
// const name = 'abc123'
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callGetRoute
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
datastreamClient
.
getRoute
(
request
);
console
.
log
(
response
);
}
callGetRoute
();
getRoute(request, options, callback)
getRoute
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IGetRouteRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datastream
.
v1
.
IRoute
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IGetRouteRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.IGetRouteRequest
options
CallOptions
callback
Callback
<protos. google.cloud.datastream.v1.IRoute
, protos. google.cloud.datastream.v1.IGetRouteRequest
| null | undefined, {} | null | undefined>
void
getRoute(request, callback)
getRoute
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IGetRouteRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
datastream
.
v1
.
IRoute
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IGetRouteRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.IGetRouteRequest
callback
Callback
<protos. google.cloud.datastream.v1.IRoute
, protos. google.cloud.datastream.v1.IGetRouteRequest
| null | undefined, {} | null | undefined>
void
getStream(request, options)
getStream
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IGetStreamRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datastream
.
v1
.
IStream
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IGetStreamRequest
|
undefined
,
{}
|
undefined
]>;
Use this method to get details about a stream.
request
protos. google.cloud.datastream.v1.IGetStreamRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.datastream.v1.IStream
,
protos. google.cloud.datastream.v1.IGetStreamRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the stream resource to get.
*/
// const name = 'abc123'
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callGetStream
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
datastreamClient
.
getStream
(
request
);
console
.
log
(
response
);
}
callGetStream
();
getStream(request, options, callback)
getStream
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IGetStreamRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datastream
.
v1
.
IStream
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IGetStreamRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.IGetStreamRequest
options
CallOptions
callback
Callback
<protos. google.cloud.datastream.v1.IStream
, protos. google.cloud.datastream.v1.IGetStreamRequest
| null | undefined, {} | null | undefined>
void
getStream(request, callback)
getStream
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IGetStreamRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
datastream
.
v1
.
IStream
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IGetStreamRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.IGetStreamRequest
callback
Callback
<protos. google.cloud.datastream.v1.IStream
, protos. google.cloud.datastream.v1.IGetStreamRequest
| null | undefined, {} | null | undefined>
void
getStreamObject(request, options)
getStreamObject
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IGetStreamObjectRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datastream
.
v1
.
IStreamObject
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IGetStreamObjectRequest
|
undefined
,
{}
|
undefined
]>;
Use this method to get details about a stream object.
request
protos. google.cloud.datastream.v1.IGetStreamObjectRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.datastream.v1.IStreamObject
,
protos. google.cloud.datastream.v1.IGetStreamObjectRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the stream object resource to get.
*/
// const name = 'abc123'
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callGetStreamObject
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
datastreamClient
.
getStreamObject
(
request
);
console
.
log
(
response
);
}
callGetStreamObject
();
getStreamObject(request, options, callback)
getStreamObject
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IGetStreamObjectRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datastream
.
v1
.
IStreamObject
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IGetStreamObjectRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.IGetStreamObjectRequest
options
CallOptions
callback
Callback
<protos. google.cloud.datastream.v1.IStreamObject
, protos. google.cloud.datastream.v1.IGetStreamObjectRequest
| null | undefined, {} | null | undefined>
void
getStreamObject(request, callback)
getStreamObject
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IGetStreamObjectRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
datastream
.
v1
.
IStreamObject
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IGetStreamObjectRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.IGetStreamObjectRequest
callback
Callback
<protos. google.cloud.datastream.v1.IStreamObject
, protos. google.cloud.datastream.v1.IGetStreamObjectRequest
| null | undefined, {} | null | undefined>
void
initialize()
initialize
()
:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Promise
<{
[name: string]: Function
;
}>
{Promise} A promise that resolves to an authenticated service stub.
listConnectionProfiles(request, options)
listConnectionProfiles
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IListConnectionProfilesRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datastream
.
v1
.
IConnectionProfile
[],
protos
.
google
.
cloud
.
datastream
.
v1
.
IListConnectionProfilesRequest
|
null
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IListConnectionProfilesResponse
]>;
Use this method to list connection profiles created in a project and location.
request
protos. google.cloud.datastream.v1.IListConnectionProfilesRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.datastream.v1.IConnectionProfile
[],
protos. google.cloud.datastream.v1.IListConnectionProfilesRequest
| null,
protos. google.cloud.datastream.v1.IListConnectionProfilesResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listConnectionProfilesAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
listConnectionProfiles(request, options, callback)
listConnectionProfiles
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IListConnectionProfilesRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datastream
.
v1
.
IListConnectionProfilesRequest
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IListConnectionProfilesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IConnectionProfile
> )
:
void
;
request
protos. google.cloud.datastream.v1.IListConnectionProfilesRequest
options
CallOptions
callback
PaginationCallback
<protos. google.cloud.datastream.v1.IListConnectionProfilesRequest
, protos. google.cloud.datastream.v1.IListConnectionProfilesResponse
| null | undefined, protos. google.cloud.datastream.v1.IConnectionProfile
>
void
listConnectionProfiles(request, callback)
listConnectionProfiles
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IListConnectionProfilesRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datastream
.
v1
.
IListConnectionProfilesRequest
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IListConnectionProfilesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IConnectionProfile
> )
:
void
;
request
protos. google.cloud.datastream.v1.IListConnectionProfilesRequest
callback
PaginationCallback
<protos. google.cloud.datastream.v1.IListConnectionProfilesRequest
, protos. google.cloud.datastream.v1.IListConnectionProfilesResponse
| null | undefined, protos. google.cloud.datastream.v1.IConnectionProfile
>
void
listConnectionProfilesAsync(request, options)
listConnectionProfilesAsync
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IListConnectionProfilesRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
datastream
.
v1
.
IConnectionProfile
> ;
Equivalent to listConnectionProfiles
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
protos. google.cloud.datastream.v1.IListConnectionProfilesRequest
The request object that will be sent.
options
AsyncIterable
<protos. google.cloud.datastream.v1.IConnectionProfile
>
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent that owns the collection of connection profiles.
*/
// const parent = 'abc123'
/**
* 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.
*/
// const pageSize = 1234
/**
* 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.
*/
// const pageToken = 'abc123'
/**
* Filter request.
*/
// const filter = 'abc123'
/**
* Order by fields for the result.
*/
// const orderBy = 'abc123'
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callListConnectionProfiles
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
await
datastreamClient
.
listConnectionProfilesAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListConnectionProfiles
();
listConnectionProfilesStream(request, options)
listConnectionProfilesStream
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IListConnectionProfilesRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
request
protos. google.cloud.datastream.v1.IListConnectionProfilesRequest
The request object that will be sent.
options
Transform
{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listConnectionProfilesAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
listLocationsAsync(request, options)
listLocationsAsync
(
request
:
LocationProtos
.
google
.
cloud
.
location
.
IListLocationsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<LocationProtos
.
google
.
cloud
.
location
.
ILocation
> ;
Lists information about the supported locations for this service. Returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
LocationProtos. google.cloud.location.IListLocationsRequest
The request object that will be sent.
options
AsyncIterable
<LocationProtos. google.cloud.location.ILocation
>
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
const
iterable
=
client
.
listLocationsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
// process response
}
listOperationsAsync(request, options)
listOperationsAsync
(
request
:
protos
.
google
.
longrunning
.
ListOperationsRequest
,
options
?:
gax
.
CallOptions
)
:
AsyncIterable<protos
.
google
.
longrunning
.
ListOperationsResponse
> ;
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
. Returns an iterable object.
For-await-of syntax is used with the iterable to recursively get response element on-demand.
request
protos. google.longrunning.ListOperationsRequest
The request object that will be sent.
options
gax. CallOptions
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
AsyncIterable
<protos. google.longrunning.ListOperationsResponse
>
{Object} An iterable Object that conforms to iteration protocols .
const
client
=
longrunning
.
operationsClient
();
for
await
(
const
response
of
client
.
listOperationsAsync
(
request
));
// doThingsWith(response)
listPrivateConnections(request, options)
listPrivateConnections
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IListPrivateConnectionsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datastream
.
v1
.
IPrivateConnection
[],
protos
.
google
.
cloud
.
datastream
.
v1
.
IListPrivateConnectionsRequest
|
null
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IListPrivateConnectionsResponse
]>;
Use this method to list private connectivity configurations in a project and location.
request
protos. google.cloud.datastream.v1.IListPrivateConnectionsRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.datastream.v1.IPrivateConnection
[],
protos. google.cloud.datastream.v1.IListPrivateConnectionsRequest
| null,
protos. google.cloud.datastream.v1.IListPrivateConnectionsResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listPrivateConnectionsAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
listPrivateConnections(request, options, callback)
listPrivateConnections
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IListPrivateConnectionsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datastream
.
v1
.
IListPrivateConnectionsRequest
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IListPrivateConnectionsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IPrivateConnection
> )
:
void
;
request
protos. google.cloud.datastream.v1.IListPrivateConnectionsRequest
options
CallOptions
callback
PaginationCallback
<protos. google.cloud.datastream.v1.IListPrivateConnectionsRequest
, protos. google.cloud.datastream.v1.IListPrivateConnectionsResponse
| null | undefined, protos. google.cloud.datastream.v1.IPrivateConnection
>
void
listPrivateConnections(request, callback)
listPrivateConnections
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IListPrivateConnectionsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datastream
.
v1
.
IListPrivateConnectionsRequest
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IListPrivateConnectionsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IPrivateConnection
> )
:
void
;
request
protos. google.cloud.datastream.v1.IListPrivateConnectionsRequest
callback
PaginationCallback
<protos. google.cloud.datastream.v1.IListPrivateConnectionsRequest
, protos. google.cloud.datastream.v1.IListPrivateConnectionsResponse
| null | undefined, protos. google.cloud.datastream.v1.IPrivateConnection
>
void
listPrivateConnectionsAsync(request, options)
listPrivateConnectionsAsync
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IListPrivateConnectionsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
datastream
.
v1
.
IPrivateConnection
> ;
Equivalent to listPrivateConnections
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
protos. google.cloud.datastream.v1.IListPrivateConnectionsRequest
The request object that will be sent.
options
AsyncIterable
<protos. google.cloud.datastream.v1.IPrivateConnection
>
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent that owns the collection of private connectivity configurations.
*/
// const parent = 'abc123'
/**
* 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.
*/
// const pageSize = 1234
/**
* 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.
*/
// const pageToken = 'abc123'
/**
* Filter request.
*/
// const filter = 'abc123'
/**
* Order by fields for the result.
*/
// const orderBy = 'abc123'
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callListPrivateConnections
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
await
datastreamClient
.
listPrivateConnectionsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListPrivateConnections
();
listPrivateConnectionsStream(request, options)
listPrivateConnectionsStream
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IListPrivateConnectionsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
request
protos. google.cloud.datastream.v1.IListPrivateConnectionsRequest
The request object that will be sent.
options
Transform
{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listPrivateConnectionsAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
listRoutes(request, options)
listRoutes
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IListRoutesRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datastream
.
v1
.
IRoute
[],
protos
.
google
.
cloud
.
datastream
.
v1
.
IListRoutesRequest
|
null
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IListRoutesResponse
]>;
Use this method to list routes created for a private connectivity configuration in a project and location.
request
protos. google.cloud.datastream.v1.IListRoutesRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.datastream.v1.IRoute
[],
protos. google.cloud.datastream.v1.IListRoutesRequest
| null,
protos. google.cloud.datastream.v1.IListRoutesResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listRoutesAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
listRoutes(request, options, callback)
listRoutes
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IListRoutesRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datastream
.
v1
.
IListRoutesRequest
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IListRoutesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IRoute
> )
:
void
;
request
protos. google.cloud.datastream.v1.IListRoutesRequest
options
CallOptions
callback
PaginationCallback
<protos. google.cloud.datastream.v1.IListRoutesRequest
, protos. google.cloud.datastream.v1.IListRoutesResponse
| null | undefined, protos. google.cloud.datastream.v1.IRoute
>
void
listRoutes(request, callback)
listRoutes
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IListRoutesRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datastream
.
v1
.
IListRoutesRequest
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IListRoutesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IRoute
> )
:
void
;
request
protos. google.cloud.datastream.v1.IListRoutesRequest
callback
PaginationCallback
<protos. google.cloud.datastream.v1.IListRoutesRequest
, protos. google.cloud.datastream.v1.IListRoutesResponse
| null | undefined, protos. google.cloud.datastream.v1.IRoute
>
void
listRoutesAsync(request, options)
listRoutesAsync
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IListRoutesRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
datastream
.
v1
.
IRoute
> ;
Equivalent to listRoutes
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
protos. google.cloud.datastream.v1.IListRoutesRequest
The request object that will be sent.
options
AsyncIterable
<protos. google.cloud.datastream.v1.IRoute
>
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent that owns the collection of Routess.
*/
// const parent = 'abc123'
/**
* 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.
*/
// const pageSize = 1234
/**
* 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.
*/
// const pageToken = 'abc123'
/**
* Filter request.
*/
// const filter = 'abc123'
/**
* Order by fields for the result.
*/
// const orderBy = 'abc123'
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callListRoutes
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
await
datastreamClient
.
listRoutesAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListRoutes
();
listRoutesStream(request, options)
listRoutesStream
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IListRoutesRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
request
protos. google.cloud.datastream.v1.IListRoutesRequest
The request object that will be sent.
options
Transform
{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listRoutesAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
listStreamObjects(request, options)
listStreamObjects
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IListStreamObjectsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datastream
.
v1
.
IStreamObject
[],
protos
.
google
.
cloud
.
datastream
.
v1
.
IListStreamObjectsRequest
|
null
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IListStreamObjectsResponse
]>;
Use this method to list the objects of a specific stream.
request
protos. google.cloud.datastream.v1.IListStreamObjectsRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.datastream.v1.IStreamObject
[],
protos. google.cloud.datastream.v1.IListStreamObjectsRequest
| null,
protos. google.cloud.datastream.v1.IListStreamObjectsResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listStreamObjectsAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
listStreamObjects(request, options, callback)
listStreamObjects
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IListStreamObjectsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datastream
.
v1
.
IListStreamObjectsRequest
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IListStreamObjectsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IStreamObject
> )
:
void
;
request
protos. google.cloud.datastream.v1.IListStreamObjectsRequest
options
CallOptions
callback
PaginationCallback
<protos. google.cloud.datastream.v1.IListStreamObjectsRequest
, protos. google.cloud.datastream.v1.IListStreamObjectsResponse
| null | undefined, protos. google.cloud.datastream.v1.IStreamObject
>
void
listStreamObjects(request, callback)
listStreamObjects
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IListStreamObjectsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datastream
.
v1
.
IListStreamObjectsRequest
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IListStreamObjectsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IStreamObject
> )
:
void
;
request
protos. google.cloud.datastream.v1.IListStreamObjectsRequest
callback
PaginationCallback
<protos. google.cloud.datastream.v1.IListStreamObjectsRequest
, protos. google.cloud.datastream.v1.IListStreamObjectsResponse
| null | undefined, protos. google.cloud.datastream.v1.IStreamObject
>
void
listStreamObjectsAsync(request, options)
listStreamObjectsAsync
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IListStreamObjectsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
datastream
.
v1
.
IStreamObject
> ;
Equivalent to listStreamObjects
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
protos. google.cloud.datastream.v1.IListStreamObjectsRequest
The request object that will be sent.
options
AsyncIterable
<protos. google.cloud.datastream.v1.IStreamObject
>
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent stream that owns the collection of objects.
*/
// const parent = 'abc123'
/**
* Maximum number of objects to return. Default is 50.
* The maximum value is 1000; values above 1000 will be coerced to 1000.
*/
// const pageSize = 1234
/**
* 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.
*/
// const pageToken = 'abc123'
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callListStreamObjects
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
await
datastreamClient
.
listStreamObjectsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListStreamObjects
();
listStreamObjectsStream(request, options)
listStreamObjectsStream
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IListStreamObjectsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
request
protos. google.cloud.datastream.v1.IListStreamObjectsRequest
The request object that will be sent.
options
Transform
{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listStreamObjectsAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
listStreams(request, options)
listStreams
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IListStreamsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datastream
.
v1
.
IStream
[],
protos
.
google
.
cloud
.
datastream
.
v1
.
IListStreamsRequest
|
null
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IListStreamsResponse
]>;
Use this method to list streams in a project and location.
request
protos. google.cloud.datastream.v1.IListStreamsRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.datastream.v1.IStream
[],
protos. google.cloud.datastream.v1.IListStreamsRequest
| null,
protos. google.cloud.datastream.v1.IListStreamsResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listStreamsAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
listStreams(request, options, callback)
listStreams
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IListStreamsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datastream
.
v1
.
IListStreamsRequest
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IListStreamsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IStream
> )
:
void
;
request
protos. google.cloud.datastream.v1.IListStreamsRequest
options
CallOptions
callback
PaginationCallback
<protos. google.cloud.datastream.v1.IListStreamsRequest
, protos. google.cloud.datastream.v1.IListStreamsResponse
| null | undefined, protos. google.cloud.datastream.v1.IStream
>
void
listStreams(request, callback)
listStreams
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IListStreamsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datastream
.
v1
.
IListStreamsRequest
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IListStreamsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IStream
> )
:
void
;
request
protos. google.cloud.datastream.v1.IListStreamsRequest
callback
PaginationCallback
<protos. google.cloud.datastream.v1.IListStreamsRequest
, protos. google.cloud.datastream.v1.IListStreamsResponse
| null | undefined, protos. google.cloud.datastream.v1.IStream
>
void
listStreamsAsync(request, options)
listStreamsAsync
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IListStreamsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
datastream
.
v1
.
IStream
> ;
Equivalent to listStreams
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
protos. google.cloud.datastream.v1.IListStreamsRequest
The request object that will be sent.
options
AsyncIterable
<protos. google.cloud.datastream.v1.IStream
>
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent that owns the collection of streams.
*/
// const parent = 'abc123'
/**
* 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.
*/
// const pageSize = 1234
/**
* 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.
*/
// const pageToken = 'abc123'
/**
* Filter request.
*/
// const filter = 'abc123'
/**
* Order by fields for the result.
*/
// const orderBy = 'abc123'
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callListStreams
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
await
datastreamClient
.
listStreamsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListStreams
();
listStreamsStream(request, options)
listStreamsStream
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IListStreamsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
request
protos. google.cloud.datastream.v1.IListStreamsRequest
The request object that will be sent.
options
Transform
{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listStreamsAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
locationPath(project, location)
locationPath
(
project
:
string
,
location
:
string
)
:
string
;
Return a fully-qualified location resource name string.
project
string
location
string
string
{string} Resource name string.
lookupStreamObject(request, options)
lookupStreamObject
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
ILookupStreamObjectRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datastream
.
v1
.
IStreamObject
,
protos
.
google
.
cloud
.
datastream
.
v1
.
ILookupStreamObjectRequest
|
undefined
,
{}
|
undefined
]>;
Use this method to look up a stream object by its source object identifier.
request
protos. google.cloud.datastream.v1.ILookupStreamObjectRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.datastream.v1.IStreamObject
,
protos. google.cloud.datastream.v1.ILookupStreamObjectRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent stream that owns the collection of objects.
*/
// const parent = 'abc123'
/**
* Required. The source object identifier which maps to the stream object.
*/
// const sourceObjectIdentifier = {}
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callLookupStreamObject
()
{
// Construct request
const
request
=
{
parent
,
sourceObjectIdentifier
,
};
// Run request
const
response
=
await
datastreamClient
.
lookupStreamObject
(
request
);
console
.
log
(
response
);
}
callLookupStreamObject
();
lookupStreamObject(request, options, callback)
lookupStreamObject
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
ILookupStreamObjectRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datastream
.
v1
.
IStreamObject
,
protos
.
google
.
cloud
.
datastream
.
v1
.
ILookupStreamObjectRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.ILookupStreamObjectRequest
options
CallOptions
callback
Callback
<protos. google.cloud.datastream.v1.IStreamObject
, protos. google.cloud.datastream.v1.ILookupStreamObjectRequest
| null | undefined, {} | null | undefined>
void
lookupStreamObject(request, callback)
lookupStreamObject
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
ILookupStreamObjectRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
datastream
.
v1
.
IStreamObject
,
protos
.
google
.
cloud
.
datastream
.
v1
.
ILookupStreamObjectRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.ILookupStreamObjectRequest
callback
Callback
<protos. google.cloud.datastream.v1.IStreamObject
, protos. google.cloud.datastream.v1.ILookupStreamObjectRequest
| null | undefined, {} | null | undefined>
void
matchConnectionProfileFromConnectionProfileName(connectionProfileName)
matchConnectionProfileFromConnectionProfileName
(
connectionProfileName
:
string
)
:
string
|
number
;
Parse the connection_profile from ConnectionProfile resource.
connectionProfileName
string
A fully-qualified path representing ConnectionProfile resource.
string | number
{string} A string representing the connection_profile.
matchLocationFromConnectionProfileName(connectionProfileName)
matchLocationFromConnectionProfileName
(
connectionProfileName
:
string
)
:
string
|
number
;
Parse the location from ConnectionProfile resource.
connectionProfileName
string
A fully-qualified path representing ConnectionProfile resource.
string | number
{string} A string representing the location.
matchLocationFromLocationName(locationName)
matchLocationFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the location from Location resource.
locationName
string
A fully-qualified path representing Location resource.
string | number
{string} A string representing the location.
matchLocationFromPrivateConnectionName(privateConnectionName)
matchLocationFromPrivateConnectionName
(
privateConnectionName
:
string
)
:
string
|
number
;
Parse the location from PrivateConnection resource.
privateConnectionName
string
A fully-qualified path representing PrivateConnection resource.
string | number
{string} A string representing the location.
matchLocationFromRouteName(routeName)
matchLocationFromRouteName
(
routeName
:
string
)
:
string
|
number
;
Parse the location from Route resource.
routeName
string
A fully-qualified path representing Route resource.
string | number
{string} A string representing the location.
matchLocationFromStreamName(streamName)
matchLocationFromStreamName
(
streamName
:
string
)
:
string
|
number
;
Parse the location from Stream resource.
streamName
string
A fully-qualified path representing Stream resource.
string | number
{string} A string representing the location.
matchLocationFromStreamObjectName(streamObjectName)
matchLocationFromStreamObjectName
(
streamObjectName
:
string
)
:
string
|
number
;
Parse the location from StreamObject resource.
streamObjectName
string
A fully-qualified path representing StreamObject resource.
string | number
{string} A string representing the location.
matchObjectFromStreamObjectName(streamObjectName)
matchObjectFromStreamObjectName
(
streamObjectName
:
string
)
:
string
|
number
;
Parse the object from StreamObject resource.
streamObjectName
string
A fully-qualified path representing StreamObject resource.
string | number
{string} A string representing the object.
matchPrivateConnectionFromPrivateConnectionName(privateConnectionName)
matchPrivateConnectionFromPrivateConnectionName
(
privateConnectionName
:
string
)
:
string
|
number
;
Parse the private_connection from PrivateConnection resource.
privateConnectionName
string
A fully-qualified path representing PrivateConnection resource.
string | number
{string} A string representing the private_connection.
matchPrivateConnectionFromRouteName(routeName)
matchPrivateConnectionFromRouteName
(
routeName
:
string
)
:
string
|
number
;
Parse the private_connection from Route resource.
routeName
string
A fully-qualified path representing Route resource.
string | number
{string} A string representing the private_connection.
matchProjectFromConnectionProfileName(connectionProfileName)
matchProjectFromConnectionProfileName
(
connectionProfileName
:
string
)
:
string
|
number
;
Parse the project from ConnectionProfile resource.
connectionProfileName
string
A fully-qualified path representing ConnectionProfile resource.
string | number
{string} A string representing the project.
matchProjectFromLocationName(locationName)
matchProjectFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the project from Location resource.
locationName
string
A fully-qualified path representing Location resource.
string | number
{string} A string representing the project.
matchProjectFromPrivateConnectionName(privateConnectionName)
matchProjectFromPrivateConnectionName
(
privateConnectionName
:
string
)
:
string
|
number
;
Parse the project from PrivateConnection resource.
privateConnectionName
string
A fully-qualified path representing PrivateConnection resource.
string | number
{string} A string representing the project.
matchProjectFromProjectName(projectName)
matchProjectFromProjectName
(
projectName
:
string
)
:
string
|
number
;
Parse the project from Project resource.
projectName
string
A fully-qualified path representing Project resource.
string | number
{string} A string representing the project.
matchProjectFromRouteName(routeName)
matchProjectFromRouteName
(
routeName
:
string
)
:
string
|
number
;
Parse the project from Route resource.
routeName
string
A fully-qualified path representing Route resource.
string | number
{string} A string representing the project.
matchProjectFromStreamName(streamName)
matchProjectFromStreamName
(
streamName
:
string
)
:
string
|
number
;
Parse the project from Stream resource.
streamName
string
A fully-qualified path representing Stream resource.
string | number
{string} A string representing the project.
matchProjectFromStreamObjectName(streamObjectName)
matchProjectFromStreamObjectName
(
streamObjectName
:
string
)
:
string
|
number
;
Parse the project from StreamObject resource.
streamObjectName
string
A fully-qualified path representing StreamObject resource.
string | number
{string} A string representing the project.
matchRouteFromRouteName(routeName)
matchRouteFromRouteName
(
routeName
:
string
)
:
string
|
number
;
Parse the route from Route resource.
routeName
string
A fully-qualified path representing Route resource.
string | number
{string} A string representing the route.
matchStreamFromStreamName(streamName)
matchStreamFromStreamName
(
streamName
:
string
)
:
string
|
number
;
Parse the stream from Stream resource.
streamName
string
A fully-qualified path representing Stream resource.
string | number
{string} A string representing the stream.
matchStreamFromStreamObjectName(streamObjectName)
matchStreamFromStreamObjectName
(
streamObjectName
:
string
)
:
string
|
number
;
Parse the stream from StreamObject resource.
streamObjectName
string
A fully-qualified path representing StreamObject resource.
string | number
{string} A string representing the stream.
privateConnectionPath(project, location, privateConnection)
privateConnectionPath
(
project
:
string
,
location
:
string
,
privateConnection
:
string
)
:
string
;
Return a fully-qualified privateConnection resource name string.
project
string
location
string
privateConnection
string
string
{string} Resource name string.
projectPath(project)
projectPath
(
project
:
string
)
:
string
;
Return a fully-qualified project resource name string.
project
string
string
{string} Resource name string.
routePath(project, location, privateConnection, route)
routePath
(
project
:
string
,
location
:
string
,
privateConnection
:
string
,
route
:
string
)
:
string
;
Return a fully-qualified route resource name string.
project
string
location
string
privateConnection
string
route
string
string
{string} Resource name string.
setIamPolicy(request, options, callback)
setIamPolicy
(
request
:
IamProtos
.
google
.
iam
.
v1
.
SetIamPolicyRequest
,
options
?:
gax
.
CallOptions
|
Callback<IamProtos
.
google
.
iam
.
v1
.
Policy
,
IamProtos
.
google
.
iam
.
v1
.
SetIamPolicyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<IamProtos
.
google
.
iam
.
v1
.
Policy
,
IamProtos
.
google
.
iam
.
v1
.
SetIamPolicyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
Promise<IamProtos
.
google
.
iam
.
v1
.
Policy
> ;
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
request
IamProtos. google.iam.v1.SetIamPolicyRequest
The request object that will be sent.
options
gax. CallOptions
| Callback
<IamProtos. google.iam.v1.Policy
, IamProtos. google.iam.v1.SetIamPolicyRequest
| null | undefined, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
<IamProtos. google.iam.v1.Policy
, IamProtos. google.iam.v1.SetIamPolicyRequest
| null | undefined, {} | null | undefined>
The function which will be called with the result of the API call.
The second parameter to the callback is an object representing .
Promise
<IamProtos. google.iam.v1.Policy
>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.
startBackfillJob(request, options)
startBackfillJob
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IStartBackfillJobRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datastream
.
v1
.
IStartBackfillJobResponse
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IStartBackfillJobRequest
|
undefined
,
{}
|
undefined
]>;
Use this method to start a backfill job for the specified stream object.
request
protos. google.cloud.datastream.v1.IStartBackfillJobRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.datastream.v1.IStartBackfillJobResponse
,
protos. google.cloud.datastream.v1.IStartBackfillJobRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the stream object resource to start a backfill job for.
*/
// const object = 'abc123'
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callStartBackfillJob
()
{
// Construct request
const
request
=
{
object
,
};
// Run request
const
response
=
await
datastreamClient
.
startBackfillJob
(
request
);
console
.
log
(
response
);
}
callStartBackfillJob
();
startBackfillJob(request, options, callback)
startBackfillJob
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IStartBackfillJobRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datastream
.
v1
.
IStartBackfillJobResponse
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IStartBackfillJobRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.IStartBackfillJobRequest
options
CallOptions
callback
Callback
<protos. google.cloud.datastream.v1.IStartBackfillJobResponse
, protos. google.cloud.datastream.v1.IStartBackfillJobRequest
| null | undefined, {} | null | undefined>
void
startBackfillJob(request, callback)
startBackfillJob
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IStartBackfillJobRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
datastream
.
v1
.
IStartBackfillJobResponse
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IStartBackfillJobRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.IStartBackfillJobRequest
callback
Callback
<protos. google.cloud.datastream.v1.IStartBackfillJobResponse
, protos. google.cloud.datastream.v1.IStartBackfillJobRequest
| null | undefined, {} | null | undefined>
void
stopBackfillJob(request, options)
stopBackfillJob
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IStopBackfillJobRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datastream
.
v1
.
IStopBackfillJobResponse
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IStopBackfillJobRequest
|
undefined
,
{}
|
undefined
]>;
Use this method to stop a backfill job for the specified stream object.
request
protos. google.cloud.datastream.v1.IStopBackfillJobRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.datastream.v1.IStopBackfillJobResponse
,
protos. google.cloud.datastream.v1.IStopBackfillJobRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the stream object resource to stop the backfill job for.
*/
// const object = 'abc123'
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callStopBackfillJob
()
{
// Construct request
const
request
=
{
object
,
};
// Run request
const
response
=
await
datastreamClient
.
stopBackfillJob
(
request
);
console
.
log
(
response
);
}
callStopBackfillJob
();
stopBackfillJob(request, options, callback)
stopBackfillJob
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IStopBackfillJobRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datastream
.
v1
.
IStopBackfillJobResponse
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IStopBackfillJobRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.IStopBackfillJobRequest
options
CallOptions
callback
Callback
<protos. google.cloud.datastream.v1.IStopBackfillJobResponse
, protos. google.cloud.datastream.v1.IStopBackfillJobRequest
| null | undefined, {} | null | undefined>
void
stopBackfillJob(request, callback)
stopBackfillJob
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IStopBackfillJobRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
datastream
.
v1
.
IStopBackfillJobResponse
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IStopBackfillJobRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.IStopBackfillJobRequest
callback
Callback
<protos. google.cloud.datastream.v1.IStopBackfillJobResponse
, protos. google.cloud.datastream.v1.IStopBackfillJobRequest
| null | undefined, {} | null | undefined>
void
streamObjectPath(project, location, stream, object)
streamObjectPath
(
project
:
string
,
location
:
string
,
stream
:
string
,
object
:
string
)
:
string
;
Return a fully-qualified streamObject resource name string.
project
string
location
string
stream
string
object
string
string
{string} Resource name string.
streamPath(project, location, stream)
streamPath
(
project
:
string
,
location
:
string
,
stream
:
string
)
:
string
;
Return a fully-qualified stream resource name string.
project
string
location
string
stream
string
string
{string} Resource name string.
testIamPermissions(request, options, callback)
testIamPermissions
(
request
:
IamProtos
.
google
.
iam
.
v1
.
TestIamPermissionsRequest
,
options
?:
gax
.
CallOptions
|
Callback<IamProtos
.
google
.
iam
.
v1
.
TestIamPermissionsResponse
,
IamProtos
.
google
.
iam
.
v1
.
TestIamPermissionsRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<IamProtos
.
google
.
iam
.
v1
.
TestIamPermissionsResponse
,
IamProtos
.
google
.
iam
.
v1
.
TestIamPermissionsRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
Promise<IamProtos
.
google
.
iam
.
v1
.
TestIamPermissionsResponse
> ;
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
request
IamProtos. google.iam.v1.TestIamPermissionsRequest
The request object that will be sent.
options
gax. CallOptions
| Callback
<IamProtos. google.iam.v1.TestIamPermissionsResponse
, IamProtos. google.iam.v1.TestIamPermissionsRequest
| null | undefined, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
<IamProtos. google.iam.v1.TestIamPermissionsResponse
, IamProtos. google.iam.v1.TestIamPermissionsRequest
| null | undefined, {} | null | undefined>
The function which will be called with the result of the API call.
The second parameter to the callback is an object representing .
Promise
<IamProtos. google.iam.v1.TestIamPermissionsResponse
>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.
updateConnectionProfile(request, options)
updateConnectionProfile
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IUpdateConnectionProfileRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
datastream
.
v1
.
IConnectionProfile
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Use this method to update the parameters of a connection profile.
request
protos. google.cloud.datastream.v1.IUpdateConnectionProfileRequest
The request object that will be sent.
options
Promise
<[ LROperation
<protos. google.cloud.datastream.v1.IConnectionProfile
, protos. google.cloud.datastream.v1.IOperationMetadata
>,
protos. google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* 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.
*/
// const updateMask = {}
/**
* Required. The connection profile to update.
*/
// const connectionProfile = {}
/**
* 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).
*/
// const requestId = 'abc123'
/**
* Optional. Only validate the connection profile, but don't update any resources.
* The default is false.
*/
// const validateOnly = true
/**
* Optional. Update the connection profile without validating it.
*/
// const force = true
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callUpdateConnectionProfile
()
{
// Construct request
const
request
=
{
connectionProfile
,
};
// Run request
const
[
operation
]
=
await
datastreamClient
.
updateConnectionProfile
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callUpdateConnectionProfile
();
updateConnectionProfile(request, options, callback)
updateConnectionProfile
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IUpdateConnectionProfileRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
datastream
.
v1
.
IConnectionProfile
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.IUpdateConnectionProfileRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.datastream.v1.IConnectionProfile
, protos. google.cloud.datastream.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
updateConnectionProfile(request, callback)
updateConnectionProfile
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IUpdateConnectionProfileRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
datastream
.
v1
.
IConnectionProfile
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.IUpdateConnectionProfileRequest
callback
Callback
< LROperation
<protos. google.cloud.datastream.v1.IConnectionProfile
, protos. google.cloud.datastream.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
updateStream(request, options)
updateStream
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1
.
IUpdateStreamRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
datastream
.
v1
.
IStream
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Use this method to update the configuration of a stream.
request
protos. google.cloud.datastream.v1.IUpdateStreamRequest
The request object that will be sent.
options
Promise
<[ LROperation
<protos. google.cloud.datastream.v1.IStream
, protos. google.cloud.datastream.v1.IOperationMetadata
>,
protos. google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* 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.
*/
// const updateMask = {}
/**
* Required. The stream resource to update.
*/
// const stream = {}
/**
* 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).
*/
// const requestId = 'abc123'
/**
* Optional. Only validate the stream with the changes, without actually updating it.
* The default is false.
*/
// const validateOnly = true
/**
* Optional. Update the stream without validating it.
*/
// const force = true
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callUpdateStream
()
{
// Construct request
const
request
=
{
stream
,
};
// Run request
const
[
operation
]
=
await
datastreamClient
.
updateStream
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callUpdateStream
();
updateStream(request, options, callback)
updateStream
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IUpdateStreamRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
datastream
.
v1
.
IStream
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.IUpdateStreamRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.datastream.v1.IStream
, protos. google.cloud.datastream.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
updateStream(request, callback)
updateStream
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1
.
IUpdateStreamRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
datastream
.
v1
.
IStream
,
protos
.
google
.
cloud
.
datastream
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.datastream.v1.IUpdateStreamRequest
callback
Callback
< LROperation
<protos. google.cloud.datastream.v1.IStream
, protos. google.cloud.datastream.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
