Datastream service v1alpha1
Package
@google-cloud/datastreamConstructors
(constructor)(opts, gaxInstance)
constructor
(
opts
?:
ClientOptions
,
gaxInstance
?:
typeof
gax
|
typeof
gax
.
fallback
);
Construct an instance of DatastreamClient.
Parameters
Name
Description
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
;
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
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
checkCreateConnectionProfileProgress(name)
checkCreateConnectionProfileProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
ConnectionProfile
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by createConnectionProfile()
.
Parameter
Name
Description
name
string
The operation name that will be passed.
Returns
Type
Description
Promise
< LROperation
<protos. google.cloud.datastream.v1alpha1.ConnectionProfile
, protos. google.cloud.datastream.v1alpha1.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'
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1alpha1
;
// 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
.
v1alpha1
.
PrivateConnection
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by createPrivateConnection()
.
Parameter
Name
Description
name
string
The operation name that will be passed.
Returns
Type
Description
Promise
< LROperation
<protos. google.cloud.datastream.v1alpha1.PrivateConnection
, protos. google.cloud.datastream.v1alpha1.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
'
).
v1alpha1
;
// 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
.
v1alpha1
.
Route
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by createRoute()
.
Parameter
Name
Description
name
string
The operation name that will be passed.
Returns
Type
Description
Promise
< LROperation
<protos. google.cloud.datastream.v1alpha1.Route
, protos. google.cloud.datastream.v1alpha1.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
'
).
v1alpha1
;
// 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
.
v1alpha1
.
Stream
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by createStream()
.
Parameter
Name
Description
name
string
The operation name that will be passed.
Returns
Type
Description
Promise
< LROperation
<protos. google.cloud.datastream.v1alpha1.Stream
, protos. google.cloud.datastream.v1alpha1.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 do not 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
'
).
v1alpha1
;
// 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
.
v1alpha1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by deleteConnectionProfile()
.
Parameter
Name
Description
name
string
The operation name that will be passed.
Returns
Type
Description
Promise
< LROperation
<protos. google.protobuf.Empty
, protos. google.cloud.datastream.v1alpha1.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
'
).
v1alpha1
;
// 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
.
v1alpha1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by deletePrivateConnection()
.
Parameter
Name
Description
name
string
The operation name that will be passed.
Returns
Type
Description
Promise
< LROperation
<protos. google.protobuf.Empty
, protos. google.cloud.datastream.v1alpha1.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
'
).
v1alpha1
;
// 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
.
v1alpha1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by deleteRoute()
.
Parameter
Name
Description
name
string
The operation name that will be passed.
Returns
Type
Description
Promise
< LROperation
<protos. google.protobuf.Empty
, protos. google.cloud.datastream.v1alpha1.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
'
).
v1alpha1
;
// 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
.
v1alpha1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by deleteStream()
.
Parameter
Name
Description
name
string
The operation name that will be passed.
Returns
Type
Description
Promise
< LROperation
<protos. google.protobuf.Empty
, protos. google.cloud.datastream.v1alpha1.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
'
).
v1alpha1
;
// 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
();
checkFetchErrorsProgress(name)
checkFetchErrorsProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
FetchErrorsResponse
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by fetchErrors()
.
Parameter
Name
Description
name
string
The operation name that will be passed.
Returns
Type
Description
Promise
< LROperation
<protos. google.cloud.datastream.v1alpha1.FetchErrorsResponse
, protos. google.cloud.datastream.v1alpha1.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.
*/
/**
* Name of the Stream resource for which to fetch any errors.
*/
// const stream = 'abc123'
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1alpha1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callFetchErrors
()
{
// Construct request
const
request
=
{
};
// Run request
const
[
operation
]
=
await
datastreamClient
.
fetchErrors
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callFetchErrors
();
checkUpdateConnectionProfileProgress(name)
checkUpdateConnectionProfileProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
ConnectionProfile
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by updateConnectionProfile()
.
Parameter
Name
Description
name
string
The operation name that will be passed.
Returns
Type
Description
Promise
< LROperation
<protos. google.cloud.datastream.v1alpha1.ConnectionProfile
, protos. google.cloud.datastream.v1alpha1.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 ConnectionProfile 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'
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1alpha1
;
// 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
.
v1alpha1
.
Stream
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by updateStream()
.
Parameter
Name
Description
name
string
The operation name that will be passed.
Returns
Type
Description
Promise
< LROperation
<protos. google.cloud.datastream.v1alpha1.Stream
, protos. google.cloud.datastream.v1alpha1.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. Execute the update without validating it.
*/
// const force = true
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1alpha1
;
// 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.
Returns
Type
Description
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.
Parameters
Name
Description
project
string
location
string
connectionProfile
string
Returns
Type
Description
string
{string} Resource name string.
createConnectionProfile(request, options)
createConnectionProfile
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
ICreateConnectionProfileRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IConnectionProfile
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Use this method to create a connection profile in a project and location.
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.ICreateConnectionProfileRequest
The request object that will be sent.
options
Returns
Type
Description
Promise
<[ LROperation
<protos. google.cloud.datastream.v1alpha1.IConnectionProfile
, protos. google.cloud.datastream.v1alpha1.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'
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1alpha1
;
// 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
.
v1alpha1
.
ICreateConnectionProfileRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IConnectionProfile
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.ICreateConnectionProfileRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.datastream.v1alpha1.IConnectionProfile
, protos. google.cloud.datastream.v1alpha1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
createConnectionProfile(request, callback)
createConnectionProfile
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
ICreateConnectionProfileRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IConnectionProfile
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.ICreateConnectionProfileRequest
callback
Callback
< LROperation
<protos. google.cloud.datastream.v1alpha1.IConnectionProfile
, protos. google.cloud.datastream.v1alpha1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
createPrivateConnection(request, options)
createPrivateConnection
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
ICreatePrivateConnectionRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IPrivateConnection
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Use this method to create a private connectivity configuration.
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.ICreatePrivateConnectionRequest
The request object that will be sent.
options
Returns
Type
Description
Promise
<[ LROperation
<protos. google.cloud.datastream.v1alpha1.IPrivateConnection
, protos. google.cloud.datastream.v1alpha1.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
'
).
v1alpha1
;
// 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
.
v1alpha1
.
ICreatePrivateConnectionRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IPrivateConnection
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.ICreatePrivateConnectionRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.datastream.v1alpha1.IPrivateConnection
, protos. google.cloud.datastream.v1alpha1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
createPrivateConnection(request, callback)
createPrivateConnection
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
ICreatePrivateConnectionRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IPrivateConnection
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.ICreatePrivateConnectionRequest
callback
Callback
< LROperation
<protos. google.cloud.datastream.v1alpha1.IPrivateConnection
, protos. google.cloud.datastream.v1alpha1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
createRoute(request, options)
createRoute
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
ICreateRouteRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IRoute
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Use this method to create a route for a private connectivity in a project and location.
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.ICreateRouteRequest
The request object that will be sent.
options
Returns
Type
Description
Promise
<[ LROperation
<protos. google.cloud.datastream.v1alpha1.IRoute
, protos. google.cloud.datastream.v1alpha1.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
'
).
v1alpha1
;
// 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
.
v1alpha1
.
ICreateRouteRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IRoute
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.ICreateRouteRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.datastream.v1alpha1.IRoute
, protos. google.cloud.datastream.v1alpha1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
createRoute(request, callback)
createRoute
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
ICreateRouteRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IRoute
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.ICreateRouteRequest
callback
Callback
< LROperation
<protos. google.cloud.datastream.v1alpha1.IRoute
, protos. google.cloud.datastream.v1alpha1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
createStream(request, options)
createStream
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
ICreateStreamRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IStream
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Use this method to create a stream.
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.ICreateStreamRequest
The request object that will be sent.
options
Returns
Type
Description
Promise
<[ LROperation
<protos. google.cloud.datastream.v1alpha1.IStream
, protos. google.cloud.datastream.v1alpha1.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 do not 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
'
).
v1alpha1
;
// 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
.
v1alpha1
.
ICreateStreamRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IStream
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.ICreateStreamRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.datastream.v1alpha1.IStream
, protos. google.cloud.datastream.v1alpha1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
createStream(request, callback)
createStream
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
ICreateStreamRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IStream
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.ICreateStreamRequest
callback
Callback
< LROperation
<protos. google.cloud.datastream.v1alpha1.IStream
, protos. google.cloud.datastream.v1alpha1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
deleteConnectionProfile(request, options)
deleteConnectionProfile
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IDeleteConnectionProfileRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Use this method to delete a connection profile..
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IDeleteConnectionProfileRequest
The request object that will be sent.
options
Returns
Type
Description
Promise
<[ LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.datastream.v1alpha1.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
'
).
v1alpha1
;
// 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
.
v1alpha1
.
IDeleteConnectionProfileRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IDeleteConnectionProfileRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.datastream.v1alpha1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
deleteConnectionProfile(request, callback)
deleteConnectionProfile
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IDeleteConnectionProfileRequest
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IDeleteConnectionProfileRequest
callback
Callback
< LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.datastream.v1alpha1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
deletePrivateConnection(request, options)
deletePrivateConnection
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IDeletePrivateConnectionRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Use this method to delete a private connectivity configuration.
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IDeletePrivateConnectionRequest
The request object that will be sent.
options
Returns
Type
Description
Promise
<[ LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.datastream.v1alpha1.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
'
).
v1alpha1
;
// 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
.
v1alpha1
.
IDeletePrivateConnectionRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IDeletePrivateConnectionRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.datastream.v1alpha1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
deletePrivateConnection(request, callback)
deletePrivateConnection
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IDeletePrivateConnectionRequest
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IDeletePrivateConnectionRequest
callback
Callback
< LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.datastream.v1alpha1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
deleteRoute(request, options)
deleteRoute
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IDeleteRouteRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Use this method to delete a route.
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IDeleteRouteRequest
The request object that will be sent.
options
Returns
Type
Description
Promise
<[ LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.datastream.v1alpha1.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
'
).
v1alpha1
;
// 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
.
v1alpha1
.
IDeleteRouteRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IDeleteRouteRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.datastream.v1alpha1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
deleteRoute(request, callback)
deleteRoute
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IDeleteRouteRequest
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IDeleteRouteRequest
callback
Callback
< LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.datastream.v1alpha1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
deleteStream(request, options)
deleteStream
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IDeleteStreamRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Use this method to delete a stream.
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IDeleteStreamRequest
The request object that will be sent.
options
Returns
Type
Description
Promise
<[ LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.datastream.v1alpha1.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
'
).
v1alpha1
;
// 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
.
v1alpha1
.
IDeleteStreamRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IDeleteStreamRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.datastream.v1alpha1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
deleteStream(request, callback)
deleteStream
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IDeleteStreamRequest
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IDeleteStreamRequest
callback
Callback
< LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.datastream.v1alpha1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
discoverConnectionProfile(request, options)
discoverConnectionProfile
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IDiscoverConnectionProfileRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IDiscoverConnectionProfileResponse
,
(
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
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 under a parent data object that's optionally supplied in the request.
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IDiscoverConnectionProfileRequest
The request object that will be sent.
options
Returns
Type
Description
Promise
<[
protos. google.cloud.datastream.v1alpha1.IDiscoverConnectionProfileResponse
,
(protos. google.cloud.datastream.v1alpha1.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 ConnectionProfile type. Must be in the
* format `projects/* /locations/*`.
*/
// const parent = 'abc123'
/**
* An ad-hoc ConnectionProfile configuration.
*/
// const connectionProfile = {}
/**
* A reference to an existing ConnectionProfile.
*/
// const connectionProfileName = 'abc123'
/**
* Whether to retrieve the full hierarchy of data objects (TRUE) or only the
* current level (FALSE).
*/
// const recursive = true
/**
* The number of hierarchy levels below the current level to be retrieved.
*/
// const recursionDepth = 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 = {}
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1alpha1
;
// 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
.
v1alpha1
.
IDiscoverConnectionProfileRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IDiscoverConnectionProfileResponse
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IDiscoverConnectionProfileRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IDiscoverConnectionProfileRequest
options
CallOptions
callback
Callback
<protos. google.cloud.datastream.v1alpha1.IDiscoverConnectionProfileResponse
, protos. google.cloud.datastream.v1alpha1.IDiscoverConnectionProfileRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
discoverConnectionProfile(request, callback)
discoverConnectionProfile
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IDiscoverConnectionProfileRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IDiscoverConnectionProfileResponse
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IDiscoverConnectionProfileRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IDiscoverConnectionProfileRequest
callback
Callback
<protos. google.cloud.datastream.v1alpha1.IDiscoverConnectionProfileResponse
, protos. google.cloud.datastream.v1alpha1.IDiscoverConnectionProfileRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
fetchErrors(request, options)
fetchErrors
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IFetchErrorsRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IFetchErrorsResponse
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Use this method to fetch any errors associated with a stream.
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IFetchErrorsRequest
The request object that will be sent.
options
Returns
Type
Description
Promise
<[ LROperation
<protos. google.cloud.datastream.v1alpha1.IFetchErrorsResponse
, protos. google.cloud.datastream.v1alpha1.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.
*/
/**
* Name of the Stream resource for which to fetch any errors.
*/
// const stream = 'abc123'
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1alpha1
;
// Instantiates a client
const
datastreamClient
=
new
DatastreamClient
();
async
function
callFetchErrors
()
{
// Construct request
const
request
=
{
};
// Run request
const
[
operation
]
=
await
datastreamClient
.
fetchErrors
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callFetchErrors
();
fetchErrors(request, options, callback)
fetchErrors
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IFetchErrorsRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IFetchErrorsResponse
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IFetchErrorsRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.datastream.v1alpha1.IFetchErrorsResponse
, protos. google.cloud.datastream.v1alpha1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
fetchErrors(request, callback)
fetchErrors
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IFetchErrorsRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IFetchErrorsResponse
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IFetchErrorsRequest
callback
Callback
< LROperation
<protos. google.cloud.datastream.v1alpha1.IFetchErrorsResponse
, protos. google.cloud.datastream.v1alpha1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
fetchStaticIps(request, options)
fetchStaticIps
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IFetchStaticIpsRequest
,
options
?:
CallOptions
)
:
Promise
< [
string
[],
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IFetchStaticIpsRequest
|
null
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IFetchStaticIpsResponse
]>;
The FetchStaticIps API call exposes the static ips used by Datastream. Typically, a request returns children data objects under a parent data object that's optionally supplied in the request.
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IFetchStaticIpsRequest
The request object that will be sent.
options
Returns
Type
Description
Promise
<[
string[],
protos. google.cloud.datastream.v1alpha1.IFetchStaticIpsRequest
| null,
protos. google.cloud.datastream.v1alpha1.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
.
v1alpha1
.
IFetchStaticIpsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IFetchStaticIpsRequest
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IFetchStaticIpsResponse
|
null
|
undefined
,
string
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IFetchStaticIpsRequest
options
CallOptions
callback
PaginationCallback
<protos. google.cloud.datastream.v1alpha1.IFetchStaticIpsRequest
, protos. google.cloud.datastream.v1alpha1.IFetchStaticIpsResponse
| null | undefined, string>
Returns
Type
Description
void
fetchStaticIps(request, callback)
fetchStaticIps
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IFetchStaticIpsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IFetchStaticIpsRequest
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IFetchStaticIpsResponse
|
null
|
undefined
,
string
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IFetchStaticIpsRequest
callback
PaginationCallback
<protos. google.cloud.datastream.v1alpha1.IFetchStaticIpsRequest
, protos. google.cloud.datastream.v1alpha1.IFetchStaticIpsResponse
| null | undefined, string>
Returns
Type
Description
void
fetchStaticIpsAsync(request, options)
fetchStaticIpsAsync
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
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.
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IFetchStaticIpsRequest
The request object that will be sent.
options
Returns
Type
Description
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 name resource of the Response type. 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
'
).
v1alpha1
;
// 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
.
v1alpha1
.
IFetchStaticIpsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IFetchStaticIpsRequest
The request object that will be sent.
options
Returns
Type
Description
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
.
v1alpha1
.
IGetConnectionProfileRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IConnectionProfile
,
(
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IGetConnectionProfileRequest
|
undefined
),
{}
|
undefined
]>;
Use this method to get details about a connection profile.
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IGetConnectionProfileRequest
The request object that will be sent.
options
Returns
Type
Description
Promise
<[
protos. google.cloud.datastream.v1alpha1.IConnectionProfile
,
(protos. google.cloud.datastream.v1alpha1.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
'
).
v1alpha1
;
// 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
.
v1alpha1
.
IGetConnectionProfileRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IConnectionProfile
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IGetConnectionProfileRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IGetConnectionProfileRequest
options
CallOptions
callback
Callback
<protos. google.cloud.datastream.v1alpha1.IConnectionProfile
, protos. google.cloud.datastream.v1alpha1.IGetConnectionProfileRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
getConnectionProfile(request, callback)
getConnectionProfile
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IGetConnectionProfileRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IConnectionProfile
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IGetConnectionProfileRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IGetConnectionProfileRequest
callback
Callback
<protos. google.cloud.datastream.v1alpha1.IConnectionProfile
, protos. google.cloud.datastream.v1alpha1.IGetConnectionProfileRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
getPrivateConnection(request, options)
getPrivateConnection
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IGetPrivateConnectionRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IPrivateConnection
,
(
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IGetPrivateConnectionRequest
|
undefined
),
{}
|
undefined
]>;
Use this method to get details about a private connectivity configuration.
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IGetPrivateConnectionRequest
The request object that will be sent.
options
Returns
Type
Description
Promise
<[
protos. google.cloud.datastream.v1alpha1.IPrivateConnection
,
(protos. google.cloud.datastream.v1alpha1.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
'
).
v1alpha1
;
// 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
.
v1alpha1
.
IGetPrivateConnectionRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IPrivateConnection
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IGetPrivateConnectionRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IGetPrivateConnectionRequest
options
CallOptions
callback
Callback
<protos. google.cloud.datastream.v1alpha1.IPrivateConnection
, protos. google.cloud.datastream.v1alpha1.IGetPrivateConnectionRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
getPrivateConnection(request, callback)
getPrivateConnection
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IGetPrivateConnectionRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IPrivateConnection
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IGetPrivateConnectionRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IGetPrivateConnectionRequest
callback
Callback
<protos. google.cloud.datastream.v1alpha1.IPrivateConnection
, protos. google.cloud.datastream.v1alpha1.IGetPrivateConnectionRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
getProjectId()
getProjectId
()
:
Promise<string>
;
Returns
Type
Description
Promise
<string>
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
Parameter
Name
Description
callback
Callback
<string, undefined, undefined>
Returns
Type
Description
void
getRoute(request, options)
getRoute
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IGetRouteRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IRoute
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IGetRouteRequest
|
undefined
,
{}
|
undefined
]>;
Use this method to get details about a route.
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IGetRouteRequest
The request object that will be sent.
options
Returns
Type
Description
Promise
<[
protos. google.cloud.datastream.v1alpha1.IRoute
,
protos. google.cloud.datastream.v1alpha1.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
'
).
v1alpha1
;
// 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
.
v1alpha1
.
IGetRouteRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IRoute
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IGetRouteRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IGetRouteRequest
options
CallOptions
callback
Callback
<protos. google.cloud.datastream.v1alpha1.IRoute
, protos. google.cloud.datastream.v1alpha1.IGetRouteRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
getRoute(request, callback)
getRoute
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IGetRouteRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IRoute
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IGetRouteRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IGetRouteRequest
callback
Callback
<protos. google.cloud.datastream.v1alpha1.IRoute
, protos. google.cloud.datastream.v1alpha1.IGetRouteRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
getStream(request, options)
getStream
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IGetStreamRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IStream
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IGetStreamRequest
|
undefined
,
{}
|
undefined
]>;
Use this method to get details about a stream.
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IGetStreamRequest
The request object that will be sent.
options
Returns
Type
Description
Promise
<[
protos. google.cloud.datastream.v1alpha1.IStream
,
protos. google.cloud.datastream.v1alpha1.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
'
).
v1alpha1
;
// 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
.
v1alpha1
.
IGetStreamRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IStream
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IGetStreamRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IGetStreamRequest
options
CallOptions
callback
Callback
<protos. google.cloud.datastream.v1alpha1.IStream
, protos. google.cloud.datastream.v1alpha1.IGetStreamRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
getStream(request, callback)
getStream
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IGetStreamRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IStream
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IGetStreamRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IGetStreamRequest
callback
Callback
<protos. google.cloud.datastream.v1alpha1.IStream
, protos. google.cloud.datastream.v1alpha1.IGetStreamRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
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.
Returns
Type
Description
Promise
<{
[name: string]: Function
;
}>
{Promise} A promise that resolves to an authenticated service stub.
listConnectionProfiles(request, options)
listConnectionProfiles
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListConnectionProfilesRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IConnectionProfile
[],
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListConnectionProfilesRequest
|
null
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListConnectionProfilesResponse
]>;
Use this method to list connection profiles created in a project and location.
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IListConnectionProfilesRequest
The request object that will be sent.
options
Returns
Type
Description
Promise
<[
protos. google.cloud.datastream.v1alpha1.IConnectionProfile
[],
protos. google.cloud.datastream.v1alpha1.IListConnectionProfilesRequest
| null,
protos. google.cloud.datastream.v1alpha1.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
.
v1alpha1
.
IListConnectionProfilesRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListConnectionProfilesRequest
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListConnectionProfilesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IConnectionProfile
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IListConnectionProfilesRequest
options
CallOptions
callback
PaginationCallback
<protos. google.cloud.datastream.v1alpha1.IListConnectionProfilesRequest
, protos. google.cloud.datastream.v1alpha1.IListConnectionProfilesResponse
| null | undefined, protos. google.cloud.datastream.v1alpha1.IConnectionProfile
>
Returns
Type
Description
void
listConnectionProfiles(request, callback)
listConnectionProfiles
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListConnectionProfilesRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListConnectionProfilesRequest
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListConnectionProfilesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IConnectionProfile
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IListConnectionProfilesRequest
callback
PaginationCallback
<protos. google.cloud.datastream.v1alpha1.IListConnectionProfilesRequest
, protos. google.cloud.datastream.v1alpha1.IListConnectionProfilesResponse
| null | undefined, protos. google.cloud.datastream.v1alpha1.IConnectionProfile
>
Returns
Type
Description
void
listConnectionProfilesAsync(request, options)
listConnectionProfilesAsync
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListConnectionProfilesRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IConnectionProfile
> ;
Equivalent to listConnectionProfiles
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IListConnectionProfilesRequest
The request object that will be sent.
options
Returns
Type
Description
AsyncIterable
<protos. google.cloud.datastream.v1alpha1.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
'
).
v1alpha1
;
// 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
.
v1alpha1
.
IListConnectionProfilesRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IListConnectionProfilesRequest
The request object that will be sent.
options
Returns
Type
Description
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.
listPrivateConnections(request, options)
listPrivateConnections
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListPrivateConnectionsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IPrivateConnection
[],
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListPrivateConnectionsRequest
|
null
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListPrivateConnectionsResponse
]>;
Use this method to list private connectivity configurations in a project and location.
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IListPrivateConnectionsRequest
The request object that will be sent.
options
Returns
Type
Description
Promise
<[
protos. google.cloud.datastream.v1alpha1.IPrivateConnection
[],
protos. google.cloud.datastream.v1alpha1.IListPrivateConnectionsRequest
| null,
protos. google.cloud.datastream.v1alpha1.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
.
v1alpha1
.
IListPrivateConnectionsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListPrivateConnectionsRequest
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListPrivateConnectionsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IPrivateConnection
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IListPrivateConnectionsRequest
options
CallOptions
callback
PaginationCallback
<protos. google.cloud.datastream.v1alpha1.IListPrivateConnectionsRequest
, protos. google.cloud.datastream.v1alpha1.IListPrivateConnectionsResponse
| null | undefined, protos. google.cloud.datastream.v1alpha1.IPrivateConnection
>
Returns
Type
Description
void
listPrivateConnections(request, callback)
listPrivateConnections
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListPrivateConnectionsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListPrivateConnectionsRequest
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListPrivateConnectionsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IPrivateConnection
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IListPrivateConnectionsRequest
callback
PaginationCallback
<protos. google.cloud.datastream.v1alpha1.IListPrivateConnectionsRequest
, protos. google.cloud.datastream.v1alpha1.IListPrivateConnectionsResponse
| null | undefined, protos. google.cloud.datastream.v1alpha1.IPrivateConnection
>
Returns
Type
Description
void
listPrivateConnectionsAsync(request, options)
listPrivateConnectionsAsync
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListPrivateConnectionsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IPrivateConnection
> ;
Equivalent to listPrivateConnections
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IListPrivateConnectionsRequest
The request object that will be sent.
options
Returns
Type
Description
AsyncIterable
<protos. google.cloud.datastream.v1alpha1.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
'
).
v1alpha1
;
// 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
.
v1alpha1
.
IListPrivateConnectionsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IListPrivateConnectionsRequest
The request object that will be sent.
options
Returns
Type
Description
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
.
v1alpha1
.
IListRoutesRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IRoute
[],
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListRoutesRequest
|
null
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListRoutesResponse
]>;
Use this method to list routes created for a private connectivity in a project and location.
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IListRoutesRequest
The request object that will be sent.
options
Returns
Type
Description
Promise
<[
protos. google.cloud.datastream.v1alpha1.IRoute
[],
protos. google.cloud.datastream.v1alpha1.IListRoutesRequest
| null,
protos. google.cloud.datastream.v1alpha1.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
.
v1alpha1
.
IListRoutesRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListRoutesRequest
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListRoutesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IRoute
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IListRoutesRequest
options
CallOptions
callback
PaginationCallback
<protos. google.cloud.datastream.v1alpha1.IListRoutesRequest
, protos. google.cloud.datastream.v1alpha1.IListRoutesResponse
| null | undefined, protos. google.cloud.datastream.v1alpha1.IRoute
>
Returns
Type
Description
void
listRoutes(request, callback)
listRoutes
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListRoutesRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListRoutesRequest
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListRoutesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IRoute
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IListRoutesRequest
callback
PaginationCallback
<protos. google.cloud.datastream.v1alpha1.IListRoutesRequest
, protos. google.cloud.datastream.v1alpha1.IListRoutesResponse
| null | undefined, protos. google.cloud.datastream.v1alpha1.IRoute
>
Returns
Type
Description
void
listRoutesAsync(request, options)
listRoutesAsync
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListRoutesRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IRoute
> ;
Equivalent to listRoutes
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IListRoutesRequest
The request object that will be sent.
options
Returns
Type
Description
AsyncIterable
<protos. google.cloud.datastream.v1alpha1.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
'
).
v1alpha1
;
// 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
.
v1alpha1
.
IListRoutesRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IListRoutesRequest
The request object that will be sent.
options
Returns
Type
Description
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.
listStreams(request, options)
listStreams
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListStreamsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IStream
[],
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListStreamsRequest
|
null
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListStreamsResponse
]>;
Use this method to list streams in a project and location.
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IListStreamsRequest
The request object that will be sent.
options
Returns
Type
Description
Promise
<[
protos. google.cloud.datastream.v1alpha1.IStream
[],
protos. google.cloud.datastream.v1alpha1.IListStreamsRequest
| null,
protos. google.cloud.datastream.v1alpha1.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
.
v1alpha1
.
IListStreamsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListStreamsRequest
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListStreamsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IStream
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IListStreamsRequest
options
CallOptions
callback
PaginationCallback
<protos. google.cloud.datastream.v1alpha1.IListStreamsRequest
, protos. google.cloud.datastream.v1alpha1.IListStreamsResponse
| null | undefined, protos. google.cloud.datastream.v1alpha1.IStream
>
Returns
Type
Description
void
listStreams(request, callback)
listStreams
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListStreamsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListStreamsRequest
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListStreamsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IStream
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IListStreamsRequest
callback
PaginationCallback
<protos. google.cloud.datastream.v1alpha1.IListStreamsRequest
, protos. google.cloud.datastream.v1alpha1.IListStreamsResponse
| null | undefined, protos. google.cloud.datastream.v1alpha1.IStream
>
Returns
Type
Description
void
listStreamsAsync(request, options)
listStreamsAsync
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IListStreamsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IStream
> ;
Equivalent to listStreams
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IListStreamsRequest
The request object that will be sent.
options
Returns
Type
Description
AsyncIterable
<protos. google.cloud.datastream.v1alpha1.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
'
).
v1alpha1
;
// 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
.
v1alpha1
.
IListStreamsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IListStreamsRequest
The request object that will be sent.
options
Returns
Type
Description
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.
Parameters
Name
Description
project
string
location
string
Returns
Type
Description
string
{string} Resource name string.
matchConnectionProfileFromConnectionProfileName(connectionProfileName)
matchConnectionProfileFromConnectionProfileName
(
connectionProfileName
:
string
)
:
string
|
number
;
Parse the connection_profile from ConnectionProfile resource.
Parameter
Name
Description
connectionProfileName
string
A fully-qualified path representing ConnectionProfile resource.
Returns
Type
Description
string | number
{string} A string representing the connection_profile.
matchLocationFromConnectionProfileName(connectionProfileName)
matchLocationFromConnectionProfileName
(
connectionProfileName
:
string
)
:
string
|
number
;
Parse the location from ConnectionProfile resource.
Parameter
Name
Description
connectionProfileName
string
A fully-qualified path representing ConnectionProfile resource.
Returns
Type
Description
string | number
{string} A string representing the location.
matchLocationFromLocationName(locationName)
matchLocationFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the location from Location resource.
Parameter
Name
Description
locationName
string
A fully-qualified path representing Location resource.
Returns
Type
Description
string | number
{string} A string representing the location.
matchLocationFromPrivateConnectionName(privateConnectionName)
matchLocationFromPrivateConnectionName
(
privateConnectionName
:
string
)
:
string
|
number
;
Parse the location from PrivateConnection resource.
Parameter
Name
Description
privateConnectionName
string
A fully-qualified path representing PrivateConnection resource.
Returns
Type
Description
string | number
{string} A string representing the location.
matchLocationFromRouteName(routeName)
matchLocationFromRouteName
(
routeName
:
string
)
:
string
|
number
;
Parse the location from Route resource.
Parameter
Name
Description
routeName
string
A fully-qualified path representing Route resource.
Returns
Type
Description
string | number
{string} A string representing the location.
matchLocationFromStreamName(streamName)
matchLocationFromStreamName
(
streamName
:
string
)
:
string
|
number
;
Parse the location from Stream resource.
Parameter
Name
Description
streamName
string
A fully-qualified path representing Stream resource.
Returns
Type
Description
string | number
{string} A string representing the location.
matchPrivateConnectionFromPrivateConnectionName(privateConnectionName)
matchPrivateConnectionFromPrivateConnectionName
(
privateConnectionName
:
string
)
:
string
|
number
;
Parse the private_connection from PrivateConnection resource.
Parameter
Name
Description
privateConnectionName
string
A fully-qualified path representing PrivateConnection resource.
Returns
Type
Description
string | number
{string} A string representing the private_connection.
matchPrivateConnectionFromRouteName(routeName)
matchPrivateConnectionFromRouteName
(
routeName
:
string
)
:
string
|
number
;
Parse the private_connection from Route resource.
Parameter
Name
Description
routeName
string
A fully-qualified path representing Route resource.
Returns
Type
Description
string | number
{string} A string representing the private_connection.
matchProjectFromConnectionProfileName(connectionProfileName)
matchProjectFromConnectionProfileName
(
connectionProfileName
:
string
)
:
string
|
number
;
Parse the project from ConnectionProfile resource.
Parameter
Name
Description
connectionProfileName
string
A fully-qualified path representing ConnectionProfile resource.
Returns
Type
Description
string | number
{string} A string representing the project.
matchProjectFromLocationName(locationName)
matchProjectFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the project from Location resource.
Parameter
Name
Description
locationName
string
A fully-qualified path representing Location resource.
Returns
Type
Description
string | number
{string} A string representing the project.
matchProjectFromPrivateConnectionName(privateConnectionName)
matchProjectFromPrivateConnectionName
(
privateConnectionName
:
string
)
:
string
|
number
;
Parse the project from PrivateConnection resource.
Parameter
Name
Description
privateConnectionName
string
A fully-qualified path representing PrivateConnection resource.
Returns
Type
Description
string | number
{string} A string representing the project.
matchProjectFromProjectName(projectName)
matchProjectFromProjectName
(
projectName
:
string
)
:
string
|
number
;
Parse the project from Project resource.
Parameter
Name
Description
projectName
string
A fully-qualified path representing Project resource.
Returns
Type
Description
string | number
{string} A string representing the project.
matchProjectFromRouteName(routeName)
matchProjectFromRouteName
(
routeName
:
string
)
:
string
|
number
;
Parse the project from Route resource.
Parameter
Name
Description
routeName
string
A fully-qualified path representing Route resource.
Returns
Type
Description
string | number
{string} A string representing the project.
matchProjectFromStreamName(streamName)
matchProjectFromStreamName
(
streamName
:
string
)
:
string
|
number
;
Parse the project from Stream resource.
Parameter
Name
Description
streamName
string
A fully-qualified path representing Stream resource.
Returns
Type
Description
string | number
{string} A string representing the project.
matchRouteFromRouteName(routeName)
matchRouteFromRouteName
(
routeName
:
string
)
:
string
|
number
;
Parse the route from Route resource.
Parameter
Name
Description
routeName
string
A fully-qualified path representing Route resource.
Returns
Type
Description
string | number
{string} A string representing the route.
matchStreamFromStreamName(streamName)
matchStreamFromStreamName
(
streamName
:
string
)
:
string
|
number
;
Parse the stream from Stream resource.
Parameter
Name
Description
streamName
string
A fully-qualified path representing Stream resource.
Returns
Type
Description
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.
Parameters
Name
Description
project
string
location
string
privateConnection
string
Returns
Type
Description
string
{string} Resource name string.
projectPath(project)
projectPath
(
project
:
string
)
:
string
;
Return a fully-qualified project resource name string.
Parameter
Name
Description
project
string
Returns
Type
Description
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.
Parameters
Name
Description
project
string
location
string
privateConnection
string
route
string
Returns
Type
Description
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.
Parameters
Name
Description
project
string
location
string
stream
string
Returns
Type
Description
string
{string} Resource name string.
updateConnectionProfile(request, options)
updateConnectionProfile
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IUpdateConnectionProfileRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IConnectionProfile
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Use this method to update the parameters of a connection profile.
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IUpdateConnectionProfileRequest
The request object that will be sent.
options
Returns
Type
Description
Promise
<[ LROperation
<protos. google.cloud.datastream.v1alpha1.IConnectionProfile
, protos. google.cloud.datastream.v1alpha1.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 ConnectionProfile 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'
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1alpha1
;
// 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
.
v1alpha1
.
IUpdateConnectionProfileRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IConnectionProfile
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IUpdateConnectionProfileRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.datastream.v1alpha1.IConnectionProfile
, protos. google.cloud.datastream.v1alpha1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
updateConnectionProfile(request, callback)
updateConnectionProfile
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IUpdateConnectionProfileRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IConnectionProfile
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IUpdateConnectionProfileRequest
callback
Callback
< LROperation
<protos. google.cloud.datastream.v1alpha1.IConnectionProfile
, protos. google.cloud.datastream.v1alpha1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
updateStream(request, options)
updateStream
(
request
?:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IUpdateStreamRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IStream
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Use this method to update the configuration of a stream.
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IUpdateStreamRequest
The request object that will be sent.
options
Returns
Type
Description
Promise
<[ LROperation
<protos. google.cloud.datastream.v1alpha1.IStream
, protos. google.cloud.datastream.v1alpha1.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. Execute the update without validating it.
*/
// const force = true
// Imports the Datastream library
const
{
DatastreamClient
}
=
require
(
' @google-cloud/datastream
'
).
v1alpha1
;
// 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
.
v1alpha1
.
IUpdateStreamRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IStream
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IUpdateStreamRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.datastream.v1alpha1.IStream
, protos. google.cloud.datastream.v1alpha1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
updateStream(request, callback)
updateStream
(
request
:
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IUpdateStreamRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IStream
,
protos
.
google
.
cloud
.
datastream
.
v1alpha1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
protos. google.cloud.datastream.v1alpha1.IUpdateStreamRequest
callback
Callback
< LROperation
<protos. google.cloud.datastream.v1alpha1.IStream
, protos. google.cloud.datastream.v1alpha1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
