DataProductService
provides APIs for managing data products and the underlying data assets. v1
Package
@google-cloud/dataplexConstructors
(constructor)(opts, gaxInstance)
constructor
(
opts
?:
ClientOptions
,
gaxInstance
?:
typeof
gax
|
typeof
gax
.
fallback
);
Construct an instance of DataProductServiceClient.
opts
ClientOptions
gaxInstance
typeof gax
| typeof 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 DataProductServiceClient({fallback: true}, gax); ```
Properties
apiEndpoint
get
apiEndpoint
()
:
string
;
The DNS address for this API service.
apiEndpoint
static
get
apiEndpoint
()
:
string
;
The DNS address for this API service - same as servicePath.
auth
auth
:
gax
.
GoogleAuth
;
dataProductServiceStub
dataProductServiceStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
descriptors
descriptors
:
Descriptors
;
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
locationsClient
locationsClient
:
LocationsClient
;
operationsClient
operationsClient
:
gax
.
OperationsClient
;
pathTemplates
pathTemplates
:
{
[
name
:
string
]
:
gax
.
PathTemplate
;
};
port
static
get
port
()
:
number
;
The port for this API service.
scopes
static
get
scopes
()
:
string
[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static
get
servicePath
()
:
string
;
The DNS address for this API service.
universeDomain
get
universeDomain
()
:
string
;
warn
warn
:
(
code
:
string
,
message
:
string
,
warnType
?:
string
)
=
>
void
;
Methods
aspectTypePath(project, location, aspectType)
aspectTypePath
(
project
:
string
,
location
:
string
,
aspectType
:
string
)
:
string
;
Return a fully-qualified aspectType resource name string.
project
string
location
string
aspectType
string
string
{string} Resource name string.
assetPath(project, location, lake, zone, asset)
assetPath
(
project
:
string
,
location
:
string
,
lake
:
string
,
zone
:
string
,
asset
:
string
)
:
string
;
Return a fully-qualified asset resource name string.
project
string
location
string
lake
string
zone
string
asset
string
string
{string} Resource name string.
cancelOperation(request, optionsOrCallback, callback)
cancelOperation
(
request
:
protos
.
google
.
longrunning
.
CancelOperationRequest
,
optionsOrCallback
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
longrunning
.
CancelOperationRequest
,
protos
.
google
.
protobuf
.
Empty
,
{}
|
undefined
|
null
> ,
callback
?:
Callback<protos
.
google
.
longrunning
.
CancelOperationRequest
,
protos
.
google
.
protobuf
.
Empty
,
{}
|
undefined
|
null
> )
:
Promise<protos
.
google
.
protobuf
.
Empty
> ;
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED
.
request
optionsOrCallback
CallOptions
| Callback
< protos.google.longrunning.CancelOperationRequest
, protos.google.protobuf.Empty
, {} | undefined | null>
callback
Callback
< protos.google.longrunning.CancelOperationRequest
, protos.google.protobuf.Empty
, {} | undefined | null>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
const
client
=
longrunning
.
operationsClient
();
await
client
.
cancelOperation
({
name
:
''
});
checkCreateDataAssetProgress(name)
checkCreateDataAssetProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
dataplex
.
v1
.
DataAsset
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by createDataAsset()
.
name
string
The operation name that will be passed.
Promise
< LROperation
< protos.google.cloud.dataplex.v1.DataAsset
, protos.google.cloud.dataplex.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation 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 where this data asset will be created.
* Format:
* projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}
*/
// const parent = 'abc123'
/**
* Optional. The ID of the data asset to create.
* The ID must conform to RFC-1034 and contain only lower-case letters (a-z),
* numbers (0-9), or hyphens, with the first character a letter, the last a
* letter or a number, and a 63 character maximum. Characters outside of
* ASCII are not permitted.
* Valid format regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`
* If not provided, a system generated ID will be used.
*/
// const dataAssetId = 'abc123'
/**
* Required. The data asset to create.
*/
// const dataAsset = {}
/**
* Optional. Validates the request without actually creating the data asset.
* Defaults to false.
*/
// const validateOnly = true
// Imports the Dataplex library
const
{
DataProductServiceClient
}
=
require
(
' @google-cloud/dataplex
'
).
v1
;
// Instantiates a client
const
dataplexClient
=
new
DataProductServiceClient
();
async
function
callCreateDataAsset
()
{
// Construct request
const
request
=
{
parent
,
dataAsset
,
};
// Run request
const
[
operation
]
=
await
dataplexClient
.
createDataAsset
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callCreateDataAsset
();
checkCreateDataProductProgress(name)
checkCreateDataProductProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
dataplex
.
v1
.
DataProduct
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by createDataProduct()
.
name
string
The operation name that will be passed.
Promise
< LROperation
< protos.google.cloud.dataplex.v1.DataProduct
, protos.google.cloud.dataplex.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation 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 where this data product will be created.
* Format: projects/{project_id_or_number}/locations/{location_id}
*/
// const parent = 'abc123'
/**
* Optional. The ID of the data product to create.
* The ID must conform to RFC-1034 and contain only lower-case letters (a-z),
* numbers (0-9), or hyphens, with the first character a letter, the last a
* letter or a number, and a 63 character maximum. Characters outside of
* ASCII are not permitted.
* Valid format regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`
* If not provided, a system generated ID will be used.
*/
// const dataProductId = 'abc123'
/**
* Required. The data product to create.
*/
// const dataProduct = {}
/**
* Optional. Validates the request without actually creating the data product.
* Default: false.
*/
// const validateOnly = true
// Imports the Dataplex library
const
{
DataProductServiceClient
}
=
require
(
' @google-cloud/dataplex
'
).
v1
;
// Instantiates a client
const
dataplexClient
=
new
DataProductServiceClient
();
async
function
callCreateDataProduct
()
{
// Construct request
const
request
=
{
parent
,
dataProduct
,
};
// Run request
const
[
operation
]
=
await
dataplexClient
.
createDataProduct
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callCreateDataProduct
();
checkDeleteDataAssetProgress(name)
checkDeleteDataAssetProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by deleteDataAsset()
.
name
string
The operation name that will be passed.
Promise
< LROperation
< protos.google.protobuf.Empty
, protos.google.cloud.dataplex.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation 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 data asset to delete.
* Format:
* projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}/dataAssets/{data_asset_id}
*/
// const name = 'abc123'
/**
* Optional. The etag of the data asset.
* If this is provided, it must match the server's etag.
* If the etag is provided and does not match the server-computed etag,
* the request must fail with a ABORTED error code.
*/
// const etag = 'abc123'
/**
* Optional. Validates the request without actually deleting the data asset.
* Defaults to false.
*/
// const validateOnly = true
// Imports the Dataplex library
const
{
DataProductServiceClient
}
=
require
(
' @google-cloud/dataplex
'
).
v1
;
// Instantiates a client
const
dataplexClient
=
new
DataProductServiceClient
();
async
function
callDeleteDataAsset
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
dataplexClient
.
deleteDataAsset
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteDataAsset
();
checkDeleteDataProductProgress(name)
checkDeleteDataProductProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by deleteDataProduct()
.
name
string
The operation name that will be passed.
Promise
< LROperation
< protos.google.protobuf.Empty
, protos.google.cloud.dataplex.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation 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 data product to delete.
* Format:
* projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}
*/
// const name = 'abc123'
/**
* Optional. The etag of the data product.
* If an etag is provided and does not match the current etag of the data
* product, then the deletion will be blocked and an ABORTED error will be
* returned.
*/
// const etag = 'abc123'
/**
* Optional. Validates the request without actually deleting the data product.
* Default: false.
*/
// const validateOnly = true
// Imports the Dataplex library
const
{
DataProductServiceClient
}
=
require
(
' @google-cloud/dataplex
'
).
v1
;
// Instantiates a client
const
dataplexClient
=
new
DataProductServiceClient
();
async
function
callDeleteDataProduct
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
dataplexClient
.
deleteDataProduct
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteDataProduct
();
checkUpdateDataAssetProgress(name)
checkUpdateDataAssetProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
dataplex
.
v1
.
DataAsset
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by updateDataAsset()
.
name
string
The operation name that will be passed.
Promise
< LROperation
< protos.google.cloud.dataplex.v1.DataAsset
, protos.google.cloud.dataplex.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation 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 data asset to update.
* The data asset's `name` field is used to identify the data asset to update.
*/
// const dataAsset = {}
/**
* Optional. The list of fields to update.
* If this is empty or not set, then all the fields will be updated.
*/
// const updateMask = {}
/**
* Optional. Validates the request without actually updating the data asset.
* Defaults to false.
*/
// const validateOnly = true
// Imports the Dataplex library
const
{
DataProductServiceClient
}
=
require
(
' @google-cloud/dataplex
'
).
v1
;
// Instantiates a client
const
dataplexClient
=
new
DataProductServiceClient
();
async
function
callUpdateDataAsset
()
{
// Construct request
const
request
=
{
dataAsset
,
};
// Run request
const
[
operation
]
=
await
dataplexClient
.
updateDataAsset
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callUpdateDataAsset
();
checkUpdateDataProductProgress(name)
checkUpdateDataProductProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
dataplex
.
v1
.
DataProduct
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by updateDataProduct()
.
name
string
The operation name that will be passed.
Promise
< LROperation
< protos.google.cloud.dataplex.v1.DataProduct
, protos.google.cloud.dataplex.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation 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 data product to update.
* The data product's `name` field is used to identify the data product to
* update.
*/
// const dataProduct = {}
/**
* Optional. The list of fields to update.
* If this is empty or not set, then all the fields will be updated.
*/
// const updateMask = {}
/**
* Optional. Validates the request without actually updating the data product.
* Default: false.
*/
// const validateOnly = true
// Imports the Dataplex library
const
{
DataProductServiceClient
}
=
require
(
' @google-cloud/dataplex
'
).
v1
;
// Instantiates a client
const
dataplexClient
=
new
DataProductServiceClient
();
async
function
callUpdateDataProduct
()
{
// Construct request
const
request
=
{
dataProduct
,
};
// Run request
const
[
operation
]
=
await
dataplexClient
.
updateDataProduct
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callUpdateDataProduct
();
close()
close
()
:
Promise<void>
;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Promise
<void>
{Promise} A promise that resolves when the client is closed.
contentPath(project, location, lake, content)
contentPath
(
project
:
string
,
location
:
string
,
lake
:
string
,
content
:
string
)
:
string
;
Return a fully-qualified content resource name string.
project
string
location
string
lake
string
content
string
string
{string} Resource name string.
createDataAsset(request, options)
createDataAsset
(
request
?:
protos
.
google
.
cloud
.
dataplex
.
v1
.
ICreateDataAssetRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataAsset
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Creates a data asset.
request
options
Promise
<[ LROperation
< protos.google.cloud.dataplex.v1.IDataAsset
, protos.google.cloud.dataplex.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the documentation
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 where this data asset will be created.
* Format:
* projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}
*/
// const parent = 'abc123'
/**
* Optional. The ID of the data asset to create.
* The ID must conform to RFC-1034 and contain only lower-case letters (a-z),
* numbers (0-9), or hyphens, with the first character a letter, the last a
* letter or a number, and a 63 character maximum. Characters outside of
* ASCII are not permitted.
* Valid format regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`
* If not provided, a system generated ID will be used.
*/
// const dataAssetId = 'abc123'
/**
* Required. The data asset to create.
*/
// const dataAsset = {}
/**
* Optional. Validates the request without actually creating the data asset.
* Defaults to false.
*/
// const validateOnly = true
// Imports the Dataplex library
const
{
DataProductServiceClient
}
=
require
(
' @google-cloud/dataplex
'
).
v1
;
// Instantiates a client
const
dataplexClient
=
new
DataProductServiceClient
();
async
function
callCreateDataAsset
()
{
// Construct request
const
request
=
{
parent
,
dataAsset
,
};
// Run request
const
[
operation
]
=
await
dataplexClient
.
createDataAsset
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callCreateDataAsset
();
createDataAsset(request, options, callback)
createDataAsset
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
ICreateDataAssetRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataAsset
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< LROperation
< protos.google.cloud.dataplex.v1.IDataAsset
, protos.google.cloud.dataplex.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
createDataAsset(request, callback)
createDataAsset
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
ICreateDataAssetRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataAsset
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< LROperation
< protos.google.cloud.dataplex.v1.IDataAsset
, protos.google.cloud.dataplex.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
createDataProduct(request, options)
createDataProduct
(
request
?:
protos
.
google
.
cloud
.
dataplex
.
v1
.
ICreateDataProductRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataProduct
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Creates a data product.
request
options
Promise
<[ LROperation
< protos.google.cloud.dataplex.v1.IDataProduct
, protos.google.cloud.dataplex.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the documentation
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 where this data product will be created.
* Format: projects/{project_id_or_number}/locations/{location_id}
*/
// const parent = 'abc123'
/**
* Optional. The ID of the data product to create.
* The ID must conform to RFC-1034 and contain only lower-case letters (a-z),
* numbers (0-9), or hyphens, with the first character a letter, the last a
* letter or a number, and a 63 character maximum. Characters outside of
* ASCII are not permitted.
* Valid format regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`
* If not provided, a system generated ID will be used.
*/
// const dataProductId = 'abc123'
/**
* Required. The data product to create.
*/
// const dataProduct = {}
/**
* Optional. Validates the request without actually creating the data product.
* Default: false.
*/
// const validateOnly = true
// Imports the Dataplex library
const
{
DataProductServiceClient
}
=
require
(
' @google-cloud/dataplex
'
).
v1
;
// Instantiates a client
const
dataplexClient
=
new
DataProductServiceClient
();
async
function
callCreateDataProduct
()
{
// Construct request
const
request
=
{
parent
,
dataProduct
,
};
// Run request
const
[
operation
]
=
await
dataplexClient
.
createDataProduct
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callCreateDataProduct
();
createDataProduct(request, options, callback)
createDataProduct
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
ICreateDataProductRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataProduct
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< LROperation
< protos.google.cloud.dataplex.v1.IDataProduct
, protos.google.cloud.dataplex.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
createDataProduct(request, callback)
createDataProduct
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
ICreateDataProductRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataProduct
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< LROperation
< protos.google.cloud.dataplex.v1.IDataProduct
, protos.google.cloud.dataplex.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
dataAssetPath(project, location, dataProduct, dataAsset)
dataAssetPath
(
project
:
string
,
location
:
string
,
dataProduct
:
string
,
dataAsset
:
string
)
:
string
;
Return a fully-qualified dataAsset resource name string.
project
string
location
string
dataProduct
string
dataAsset
string
string
{string} Resource name string.
dataAttributeBindingPath(project, location, dataAttributeBindingId)
dataAttributeBindingPath
(
project
:
string
,
location
:
string
,
dataAttributeBindingId
:
string
)
:
string
;
Return a fully-qualified dataAttributeBinding resource name string.
project
string
location
string
dataAttributeBindingId
string
string
{string} Resource name string.
dataAttributePath(project, location, dataTaxonomy, dataAttributeId)
dataAttributePath
(
project
:
string
,
location
:
string
,
dataTaxonomy
:
string
,
dataAttributeId
:
string
)
:
string
;
Return a fully-qualified dataAttribute resource name string.
project
string
location
string
dataTaxonomy
string
dataAttributeId
string
string
{string} Resource name string.
dataProductPath(project, location, dataProduct)
dataProductPath
(
project
:
string
,
location
:
string
,
dataProduct
:
string
)
:
string
;
Return a fully-qualified dataProduct resource name string.
project
string
location
string
dataProduct
string
string
{string} Resource name string.
dataScanJobPath(project, location, dataScan, job)
dataScanJobPath
(
project
:
string
,
location
:
string
,
dataScan
:
string
,
job
:
string
)
:
string
;
Return a fully-qualified dataScanJob resource name string.
project
string
location
string
dataScan
string
job
string
string
{string} Resource name string.
dataScanPath(project, location, dataScan)
dataScanPath
(
project
:
string
,
location
:
string
,
dataScan
:
string
)
:
string
;
Return a fully-qualified dataScan resource name string.
project
string
location
string
dataScan
string
string
{string} Resource name string.
dataTaxonomyPath(project, location, dataTaxonomyId)
dataTaxonomyPath
(
project
:
string
,
location
:
string
,
dataTaxonomyId
:
string
)
:
string
;
Return a fully-qualified dataTaxonomy resource name string.
project
string
location
string
dataTaxonomyId
string
string
{string} Resource name string.
deleteDataAsset(request, options)
deleteDataAsset
(
request
?:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IDeleteDataAssetRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Deletes a data asset.
request
options
Promise
<[ LROperation
< protos.google.protobuf.IEmpty
, protos.google.cloud.dataplex.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the documentation
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 data asset to delete.
* Format:
* projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}/dataAssets/{data_asset_id}
*/
// const name = 'abc123'
/**
* Optional. The etag of the data asset.
* If this is provided, it must match the server's etag.
* If the etag is provided and does not match the server-computed etag,
* the request must fail with a ABORTED error code.
*/
// const etag = 'abc123'
/**
* Optional. Validates the request without actually deleting the data asset.
* Defaults to false.
*/
// const validateOnly = true
// Imports the Dataplex library
const
{
DataProductServiceClient
}
=
require
(
' @google-cloud/dataplex
'
).
v1
;
// Instantiates a client
const
dataplexClient
=
new
DataProductServiceClient
();
async
function
callDeleteDataAsset
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
dataplexClient
.
deleteDataAsset
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteDataAsset
();
deleteDataAsset(request, options, callback)
deleteDataAsset
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IDeleteDataAssetRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< LROperation
< protos.google.protobuf.IEmpty
, protos.google.cloud.dataplex.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deleteDataAsset(request, callback)
deleteDataAsset
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IDeleteDataAssetRequest
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< LROperation
< protos.google.protobuf.IEmpty
, protos.google.cloud.dataplex.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deleteDataProduct(request, options)
deleteDataProduct
(
request
?:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IDeleteDataProductRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Deletes a data product. The deletion will fail if the data product is not empty (i.e. contains at least one data asset).
request
options
Promise
<[ LROperation
< protos.google.protobuf.IEmpty
, protos.google.cloud.dataplex.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the documentation
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 data product to delete.
* Format:
* projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}
*/
// const name = 'abc123'
/**
* Optional. The etag of the data product.
* If an etag is provided and does not match the current etag of the data
* product, then the deletion will be blocked and an ABORTED error will be
* returned.
*/
// const etag = 'abc123'
/**
* Optional. Validates the request without actually deleting the data product.
* Default: false.
*/
// const validateOnly = true
// Imports the Dataplex library
const
{
DataProductServiceClient
}
=
require
(
' @google-cloud/dataplex
'
).
v1
;
// Instantiates a client
const
dataplexClient
=
new
DataProductServiceClient
();
async
function
callDeleteDataProduct
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
dataplexClient
.
deleteDataProduct
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteDataProduct
();
deleteDataProduct(request, options, callback)
deleteDataProduct
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IDeleteDataProductRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< LROperation
< protos.google.protobuf.IEmpty
, protos.google.cloud.dataplex.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deleteDataProduct(request, callback)
deleteDataProduct
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IDeleteDataProductRequest
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< LROperation
< protos.google.protobuf.IEmpty
, protos.google.cloud.dataplex.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deleteOperation(request, optionsOrCallback, callback)
deleteOperation
(
request
:
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
optionsOrCallback
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
{}
|
null
|
undefined
> )
:
Promise<protos
.
google
.
protobuf
.
Empty
> ;
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
request
optionsOrCallback
CallOptions
| Callback
< protos.google.protobuf.Empty
, protos.google.longrunning.DeleteOperationRequest
, {} | null | undefined>
callback
Callback
< protos.google.protobuf.Empty
, protos.google.longrunning.DeleteOperationRequest
, {} | null | undefined>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
const
client
=
longrunning
.
operationsClient
();
await
client
.
deleteOperation
({
name
:
''
});
encryptionConfigPath(organization, location, encryptionConfig)
encryptionConfigPath
(
organization
:
string
,
location
:
string
,
encryptionConfig
:
string
)
:
string
;
Return a fully-qualified encryptionConfig resource name string.
organization
string
location
string
encryptionConfig
string
string
{string} Resource name string.
entityPath(project, location, lake, zone, entity)
entityPath
(
project
:
string
,
location
:
string
,
lake
:
string
,
zone
:
string
,
entity
:
string
)
:
string
;
Return a fully-qualified entity resource name string.
project
string
location
string
lake
string
zone
string
entity
string
string
{string} Resource name string.
entryGroupPath(project, location, entryGroup)
entryGroupPath
(
project
:
string
,
location
:
string
,
entryGroup
:
string
)
:
string
;
Return a fully-qualified entryGroup resource name string.
project
string
location
string
entryGroup
string
string
{string} Resource name string.
entryLinkPath(project, location, entryGroup, entryLink)
entryLinkPath
(
project
:
string
,
location
:
string
,
entryGroup
:
string
,
entryLink
:
string
)
:
string
;
Return a fully-qualified entryLink resource name string.
project
string
location
string
entryGroup
string
entryLink
string
string
{string} Resource name string.
entryPath(project, location, entryGroup, entry)
entryPath
(
project
:
string
,
location
:
string
,
entryGroup
:
string
,
entry
:
string
)
:
string
;
Return a fully-qualified entry resource name string.
project
string
location
string
entryGroup
string
entry
string
string
{string} Resource name string.
entryTypePath(project, location, entryType)
entryTypePath
(
project
:
string
,
location
:
string
,
entryType
:
string
)
:
string
;
Return a fully-qualified entryType resource name string.
project
string
location
string
entryType
string
string
{string} Resource name string.
environmentPath(project, location, lake, environment)
environmentPath
(
project
:
string
,
location
:
string
,
lake
:
string
,
environment
:
string
)
:
string
;
Return a fully-qualified environment resource name string.
project
string
location
string
lake
string
environment
string
string
{string} Resource name string.
getDataAsset(request, options)
getDataAsset
(
request
?:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IGetDataAssetRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataAsset
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IGetDataAssetRequest
|
undefined
,
{}
|
undefined
]>;
Gets a data asset.
request
options
Promise
<[ protos.google.cloud.dataplex.v1.IDataAsset
, protos.google.cloud.dataplex.v1.IGetDataAssetRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation 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 data asset to retrieve.
* Format:
* projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}/dataAssets/{data_asset_id}
*/
// const name = 'abc123'
// Imports the Dataplex library
const
{
DataProductServiceClient
}
=
require
(
' @google-cloud/dataplex
'
).
v1
;
// Instantiates a client
const
dataplexClient
=
new
DataProductServiceClient
();
async
function
callGetDataAsset
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
dataplexClient
.
getDataAsset
(
request
);
console
.
log
(
response
);
}
callGetDataAsset
();
getDataAsset(request, options, callback)
getDataAsset
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IGetDataAssetRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataAsset
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IGetDataAssetRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.dataplex.v1.IDataAsset
, protos.google.cloud.dataplex.v1.IGetDataAssetRequest
| null | undefined, {} | null | undefined>
void
getDataAsset(request, callback)
getDataAsset
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IGetDataAssetRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataAsset
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IGetDataAssetRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.dataplex.v1.IDataAsset
, protos.google.cloud.dataplex.v1.IGetDataAssetRequest
| null | undefined, {} | null | undefined>
void
getDataProduct(request, options)
getDataProduct
(
request
?:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IGetDataProductRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataProduct
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IGetDataProductRequest
|
undefined
,
{}
|
undefined
]>;
Gets a data product.
request
options
Promise
<[ protos.google.cloud.dataplex.v1.IDataProduct
, protos.google.cloud.dataplex.v1.IGetDataProductRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation 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 data product to retrieve.
* Format:
* projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}
*/
// const name = 'abc123'
// Imports the Dataplex library
const
{
DataProductServiceClient
}
=
require
(
' @google-cloud/dataplex
'
).
v1
;
// Instantiates a client
const
dataplexClient
=
new
DataProductServiceClient
();
async
function
callGetDataProduct
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
dataplexClient
.
getDataProduct
(
request
);
console
.
log
(
response
);
}
callGetDataProduct
();
getDataProduct(request, options, callback)
getDataProduct
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IGetDataProductRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataProduct
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IGetDataProductRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.dataplex.v1.IDataProduct
, protos.google.cloud.dataplex.v1.IGetDataProductRequest
| null | undefined, {} | null | undefined>
void
getDataProduct(request, callback)
getDataProduct
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IGetDataProductRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataProduct
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IGetDataProductRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.dataplex.v1.IDataProduct
, protos.google.cloud.dataplex.v1.IGetDataProductRequest
| null | undefined, {} | null | undefined>
void
getLocation(request, options, callback)
getLocation
(
request
:
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
,
options
?:
gax
.
CallOptions
|
Callback<LocationProtos
.
google
.
cloud
.
location
.
ILocation
,
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<LocationProtos
.
google
.
cloud
.
location
.
ILocation
,
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
Promise<LocationProtos
.
google
.
cloud
.
location
.
ILocation
> ;
Gets information about a location.
request
LocationProtos.google.cloud.location.IGetLocationRequest
The request object that will be sent.
options
CallOptions
| Callback
< google.cloud.location.ILocation
, google.cloud.location.IGetLocationRequest
| null | undefined, {} | null | undefined>
Call options. See CallOptions for more details.
callback
Callback
< google.cloud.location.ILocation
, google.cloud.location.IGetLocationRequest
| null | undefined, {} | null | undefined>
Promise
< google.cloud.location.ILocation
>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
const
[
response
]
=
await
client
.
getLocation
(
request
);
getOperation(request, optionsOrCallback, callback)
getOperation
(
request
:
protos
.
google
.
longrunning
.
GetOperationRequest
,
optionsOrCallback
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
longrunning
.
Operation
,
protos
.
google
.
longrunning
.
GetOperationRequest
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<protos
.
google
.
longrunning
.
Operation
,
protos
.
google
.
longrunning
.
GetOperationRequest
,
{}
|
null
|
undefined
> )
:
Promise
< [
protos
.
google
.
longrunning
.
Operation
]>;
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
request
optionsOrCallback
CallOptions
| Callback
< protos.google.longrunning.Operation
, protos.google.longrunning.GetOperationRequest
, {} | null | undefined>
callback
Callback
< protos.google.longrunning.Operation
, protos.google.longrunning.GetOperationRequest
, {} | null | undefined>
The function which will be called with the result of the API call.
The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.
const
client
=
longrunning
.
operationsClient
();
const
name
=
''
;
const
[
response
]
=
await
client
.
getOperation
({
name
});
// doThingsWith(response)
getProjectId()
getProjectId
()
:
Promise<string>
;
Promise
<string>
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
callback
Callback
<string, undefined, undefined>
void
glossaryCategoryPath(project, location, glossary, glossaryCategory)
glossaryCategoryPath
(
project
:
string
,
location
:
string
,
glossary
:
string
,
glossaryCategory
:
string
)
:
string
;
Return a fully-qualified glossaryCategory resource name string.
project
string
location
string
glossary
string
glossaryCategory
string
string
{string} Resource name string.
glossaryPath(project, location, glossary)
glossaryPath
(
project
:
string
,
location
:
string
,
glossary
:
string
)
:
string
;
Return a fully-qualified glossary resource name string.
project
string
location
string
glossary
string
string
{string} Resource name string.
glossaryTermPath(project, location, glossary, glossaryTerm)
glossaryTermPath
(
project
:
string
,
location
:
string
,
glossary
:
string
,
glossaryTerm
:
string
)
:
string
;
Return a fully-qualified glossaryTerm resource name string.
project
string
location
string
glossary
string
glossaryTerm
string
string
{string} Resource name string.
initialize()
initialize
()
:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Promise
<{
[name: string]: Function
;
}>
{Promise} A promise that resolves to an authenticated service stub.
jobPath(project, location, lake, task, job)
jobPath
(
project
:
string
,
location
:
string
,
lake
:
string
,
task
:
string
,
job
:
string
)
:
string
;
Return a fully-qualified job resource name string.
project
string
location
string
lake
string
task
string
job
string
string
{string} Resource name string.
lakePath(project, location, lake)
lakePath
(
project
:
string
,
location
:
string
,
lake
:
string
)
:
string
;
Return a fully-qualified lake resource name string.
project
string
location
string
lake
string
string
{string} Resource name string.
listDataAssets(request, options)
listDataAssets
(
request
?:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataAssetsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataAsset
[],
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataAssetsRequest
|
null
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataAssetsResponse
]>;
Lists data assets for a given data product.
request
options
Promise
<[ protos.google.cloud.dataplex.v1.IDataAsset
[], protos.google.cloud.dataplex.v1.IListDataAssetsRequest
| null, protos.google.cloud.dataplex.v1.IListDataAssetsResponse
]>
{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 listDataAssetsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listDataAssets(request, options, callback)
listDataAssets
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataAssetsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataAssetsRequest
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataAssetsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataAsset
> )
:
void
;
request
options
CallOptions
callback
PaginationCallback
< protos.google.cloud.dataplex.v1.IListDataAssetsRequest
, protos.google.cloud.dataplex.v1.IListDataAssetsResponse
| null | undefined, protos.google.cloud.dataplex.v1.IDataAsset
>
void
listDataAssets(request, callback)
listDataAssets
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataAssetsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataAssetsRequest
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataAssetsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataAsset
> )
:
void
;
request
callback
PaginationCallback
< protos.google.cloud.dataplex.v1.IListDataAssetsRequest
, protos.google.cloud.dataplex.v1.IListDataAssetsResponse
| null | undefined, protos.google.cloud.dataplex.v1.IDataAsset
>
void
listDataAssetsAsync(request, options)
listDataAssetsAsync
(
request
?:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataAssetsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataAsset
> ;
Equivalent to listDataAssets
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
options
AsyncIterable
< protos.google.cloud.dataplex.v1.IDataAsset
>
{Object} An iterable Object that allows async iteration . 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 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, which has this collection of data assets.
* Format:
* projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}
*/
// const parent = 'abc123'
/**
* Optional. Filter expression that filters data assets listed in the
* response.
*/
// const filter = 'abc123'
/**
* Optional. Order by expression that orders data assets listed in the
* response.
* Supported `order_by` fields are: `name` or `create_time`.
* If not specified, the ordering is undefined.
*/
// const orderBy = 'abc123'
/**
* Optional. The maximum number of data assets to return. The service may
* return fewer than this value. If unspecified, at most 50 data assets will
* be returned. The maximum value is 1000; values above 1000 will be coerced
* to 1000.
*/
// const pageSize = 1234
/**
* Optional. A page token, received from a previous `ListDataAssets` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListDataAssets` must
* match the call that provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Dataplex library
const
{
DataProductServiceClient
}
=
require
(
' @google-cloud/dataplex
'
).
v1
;
// Instantiates a client
const
dataplexClient
=
new
DataProductServiceClient
();
async
function
callListDataAssets
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
dataplexClient
.
listDataAssetsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListDataAssets
();
listDataAssetsStream(request, options)
listDataAssetsStream
(
request
?:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataAssetsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to listDataAssets
, but returns a NodeJS Stream object.
request
options
Transform
{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listDataAssetsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listDataProducts(request, options)
listDataProducts
(
request
?:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataProductsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataProduct
[],
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataProductsRequest
|
null
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataProductsResponse
]>;
Lists data products for a given project.
request
options
Promise
<[ protos.google.cloud.dataplex.v1.IDataProduct
[], protos.google.cloud.dataplex.v1.IListDataProductsRequest
| null, protos.google.cloud.dataplex.v1.IListDataProductsResponse
]>
{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 listDataProductsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listDataProducts(request, options, callback)
listDataProducts
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataProductsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataProductsRequest
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataProductsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataProduct
> )
:
void
;
request
options
CallOptions
callback
PaginationCallback
< protos.google.cloud.dataplex.v1.IListDataProductsRequest
, protos.google.cloud.dataplex.v1.IListDataProductsResponse
| null | undefined, protos.google.cloud.dataplex.v1.IDataProduct
>
void
listDataProducts(request, callback)
listDataProducts
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataProductsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataProductsRequest
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataProductsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataProduct
> )
:
void
;
request
callback
PaginationCallback
< protos.google.cloud.dataplex.v1.IListDataProductsRequest
, protos.google.cloud.dataplex.v1.IListDataProductsResponse
| null | undefined, protos.google.cloud.dataplex.v1.IDataProduct
>
void
listDataProductsAsync(request, options)
listDataProductsAsync
(
request
?:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataProductsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataProduct
> ;
Equivalent to listDataProducts
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
options
AsyncIterable
< protos.google.cloud.dataplex.v1.IDataProduct
>
{Object} An iterable Object that allows async iteration . 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 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, which has this collection of data products.
* Format: `projects/{project_id_or_number}/locations/{location_id}`.
* Supports listing across all locations with the wildcard `-` (hyphen)
* character. Example: `projects/{project_id_or_number}/locations/-`
*/
// const parent = 'abc123'
/**
* Optional. Filter expression that filters data products listed in the
* response.
* Example of using this filter is: `display_name="my-data-product"`
*/
// const filter = 'abc123'
/**
* Optional. The maximum number of data products to return. The service may
* return fewer than this value. If unspecified, at most 50 data products will
* be returned. The maximum value is 1000; values above 1000 will be coerced
* to 1000.
*/
// const pageSize = 1234
/**
* Optional. A page token, received from a previous `ListDataProducts` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListDataProducts` must
* match the call that provided the page token.
*/
// const pageToken = 'abc123'
/**
* Optional. Order by expression that orders data products listed in the
* response.
* Supported Order by fields are: `name` or `create_time`.
* If not specified, the ordering is undefined.
* Ordering by `create_time` is not supported when listing resources across
* locations (i.e. when request contains `/locations/-`).
*/
// const orderBy = 'abc123'
// Imports the Dataplex library
const
{
DataProductServiceClient
}
=
require
(
' @google-cloud/dataplex
'
).
v1
;
// Instantiates a client
const
dataplexClient
=
new
DataProductServiceClient
();
async
function
callListDataProducts
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
dataplexClient
.
listDataProductsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListDataProducts
();
listDataProductsStream(request, options)
listDataProductsStream
(
request
?:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataProductsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to listDataProducts
, but returns a NodeJS Stream object.
request
options
Transform
{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listDataProductsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listLocationsAsync(request, options)
listLocationsAsync
(
request
:
LocationProtos
.
google
.
cloud
.
location
.
IListLocationsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<LocationProtos
.
google
.
cloud
.
location
.
ILocation
> ;
Lists information about the supported locations for this service. Returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
LocationProtos.google.cloud.location.IListLocationsRequest
The request object that will be sent.
options
AsyncIterable
< google.cloud.location.ILocation
>
{Object} An iterable Object that allows async iteration . 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 for more details and examples.
const
iterable
=
client
.
listLocationsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
// process response
}
listOperationsAsync(request, options)
listOperationsAsync
(
request
:
protos
.
google
.
longrunning
.
ListOperationsRequest
,
options
?:
gax
.
CallOptions
)
:
AsyncIterable<protos
.
google
.
longrunning
.
IOperation
> ;
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
. Returns an iterable object.
For-await-of syntax is used with the iterable to recursively get response element on-demand.
request
options
CallOptions
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
AsyncIterable
< protos.google.longrunning.IOperation
>
{Object} An iterable Object that conforms to iteration protocols .
const
client
=
longrunning
.
operationsClient
();
for
await
(
const
response
of
client
.
listOperationsAsync
(
request
));
// doThingsWith(response)
locationPath(project, location)
locationPath
(
project
:
string
,
location
:
string
)
:
string
;
Return a fully-qualified location resource name string.
project
string
location
string
string
{string} Resource name string.
matchActionFromProjectLocationLakeActionName(projectLocationLakeActionName)
matchActionFromProjectLocationLakeActionName
(
projectLocationLakeActionName
:
string
)
:
string
|
number
;
Parse the action from ProjectLocationLakeAction resource.
projectLocationLakeActionName
string
A fully-qualified path representing project_location_lake_action resource.
string | number
{string} A string representing the action.
matchActionFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)
matchActionFromProjectLocationLakeZoneActionName
(
projectLocationLakeZoneActionName
:
string
)
:
string
|
number
;
Parse the action from ProjectLocationLakeZoneAction resource.
projectLocationLakeZoneActionName
string
A fully-qualified path representing project_location_lake_zone_action resource.
string | number
{string} A string representing the action.
matchActionFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)
matchActionFromProjectLocationLakeZoneAssetActionName
(
projectLocationLakeZoneAssetActionName
:
string
)
:
string
|
number
;
Parse the action from ProjectLocationLakeZoneAssetAction resource.
projectLocationLakeZoneAssetActionName
string
A fully-qualified path representing project_location_lake_zone_asset_action resource.
string | number
{string} A string representing the action.
matchAspectTypeFromAspectTypeName(aspectTypeName)
matchAspectTypeFromAspectTypeName
(
aspectTypeName
:
string
)
:
string
|
number
;
Parse the aspect_type from AspectType resource.
aspectTypeName
string
A fully-qualified path representing AspectType resource.
string | number
{string} A string representing the aspect_type.
matchAssetFromAssetName(assetName)
matchAssetFromAssetName
(
assetName
:
string
)
:
string
|
number
;
Parse the asset from Asset resource.
assetName
string
A fully-qualified path representing Asset resource.
string | number
{string} A string representing the asset.
matchAssetFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)
matchAssetFromProjectLocationLakeZoneAssetActionName
(
projectLocationLakeZoneAssetActionName
:
string
)
:
string
|
number
;
Parse the asset from ProjectLocationLakeZoneAssetAction resource.
projectLocationLakeZoneAssetActionName
string
A fully-qualified path representing project_location_lake_zone_asset_action resource.
string | number
{string} A string representing the asset.
matchContentFromContentName(contentName)
matchContentFromContentName
(
contentName
:
string
)
:
string
|
number
;
Parse the content from Content resource.
contentName
string
A fully-qualified path representing Content resource.
string | number
{string} A string representing the content.
matchDataAssetFromDataAssetName(dataAssetName)
matchDataAssetFromDataAssetName
(
dataAssetName
:
string
)
:
string
|
number
;
Parse the data_asset from DataAsset resource.
dataAssetName
string
A fully-qualified path representing DataAsset resource.
string | number
{string} A string representing the data_asset.
matchDataAttributeBindingIdFromDataAttributeBindingName(dataAttributeBindingName)
matchDataAttributeBindingIdFromDataAttributeBindingName
(
dataAttributeBindingName
:
string
)
:
string
|
number
;
Parse the data_attribute_binding_id from DataAttributeBinding resource.
dataAttributeBindingName
string
A fully-qualified path representing DataAttributeBinding resource.
string | number
{string} A string representing the data_attribute_binding_id.
matchDataAttributeIdFromDataAttributeName(dataAttributeName)
matchDataAttributeIdFromDataAttributeName
(
dataAttributeName
:
string
)
:
string
|
number
;
Parse the data_attribute_id from DataAttribute resource.
dataAttributeName
string
A fully-qualified path representing DataAttribute resource.
string | number
{string} A string representing the data_attribute_id.
matchDataProductFromDataAssetName(dataAssetName)
matchDataProductFromDataAssetName
(
dataAssetName
:
string
)
:
string
|
number
;
Parse the data_product from DataAsset resource.
dataAssetName
string
A fully-qualified path representing DataAsset resource.
string | number
{string} A string representing the data_product.
matchDataProductFromDataProductName(dataProductName)
matchDataProductFromDataProductName
(
dataProductName
:
string
)
:
string
|
number
;
Parse the data_product from DataProduct resource.
dataProductName
string
A fully-qualified path representing DataProduct resource.
string | number
{string} A string representing the data_product.
matchDataScanFromDataScanJobName(dataScanJobName)
matchDataScanFromDataScanJobName
(
dataScanJobName
:
string
)
:
string
|
number
;
Parse the dataScan from DataScanJob resource.
dataScanJobName
string
A fully-qualified path representing DataScanJob resource.
string | number
{string} A string representing the dataScan.
matchDataScanFromDataScanName(dataScanName)
matchDataScanFromDataScanName
(
dataScanName
:
string
)
:
string
|
number
;
Parse the dataScan from DataScan resource.
dataScanName
string
A fully-qualified path representing DataScan resource.
string | number
{string} A string representing the dataScan.
matchDataTaxonomyFromDataAttributeName(dataAttributeName)
matchDataTaxonomyFromDataAttributeName
(
dataAttributeName
:
string
)
:
string
|
number
;
Parse the dataTaxonomy from DataAttribute resource.
dataAttributeName
string
A fully-qualified path representing DataAttribute resource.
string | number
{string} A string representing the dataTaxonomy.
matchDataTaxonomyIdFromDataTaxonomyName(dataTaxonomyName)
matchDataTaxonomyIdFromDataTaxonomyName
(
dataTaxonomyName
:
string
)
:
string
|
number
;
Parse the data_taxonomy_id from DataTaxonomy resource.
dataTaxonomyName
string
A fully-qualified path representing DataTaxonomy resource.
string | number
{string} A string representing the data_taxonomy_id.
matchEncryptionConfigFromEncryptionConfigName(encryptionConfigName)
matchEncryptionConfigFromEncryptionConfigName
(
encryptionConfigName
:
string
)
:
string
|
number
;
Parse the encryption_config from EncryptionConfig resource.
encryptionConfigName
string
A fully-qualified path representing EncryptionConfig resource.
string | number
{string} A string representing the encryption_config.
matchEntityFromEntityName(entityName)
matchEntityFromEntityName
(
entityName
:
string
)
:
string
|
number
;
Parse the entity from Entity resource.
entityName
string
A fully-qualified path representing Entity resource.
string | number
{string} A string representing the entity.
matchEntityFromPartitionName(partitionName)
matchEntityFromPartitionName
(
partitionName
:
string
)
:
string
|
number
;
Parse the entity from Partition resource.
partitionName
string
A fully-qualified path representing Partition resource.
string | number
{string} A string representing the entity.
matchEntryFromEntryName(entryName)
matchEntryFromEntryName
(
entryName
:
string
)
:
string
|
number
;
Parse the entry from Entry resource.
entryName
string
A fully-qualified path representing Entry resource.
string | number
{string} A string representing the entry.
matchEntryGroupFromEntryGroupName(entryGroupName)
matchEntryGroupFromEntryGroupName
(
entryGroupName
:
string
)
:
string
|
number
;
Parse the entry_group from EntryGroup resource.
entryGroupName
string
A fully-qualified path representing EntryGroup resource.
string | number
{string} A string representing the entry_group.
matchEntryGroupFromEntryLinkName(entryLinkName)
matchEntryGroupFromEntryLinkName
(
entryLinkName
:
string
)
:
string
|
number
;
Parse the entry_group from EntryLink resource.
entryLinkName
string
A fully-qualified path representing EntryLink resource.
string | number
{string} A string representing the entry_group.
matchEntryGroupFromEntryName(entryName)
matchEntryGroupFromEntryName
(
entryName
:
string
)
:
string
|
number
;
Parse the entry_group from Entry resource.
entryName
string
A fully-qualified path representing Entry resource.
string | number
{string} A string representing the entry_group.
matchEntryLinkFromEntryLinkName(entryLinkName)
matchEntryLinkFromEntryLinkName
(
entryLinkName
:
string
)
:
string
|
number
;
Parse the entry_link from EntryLink resource.
entryLinkName
string
A fully-qualified path representing EntryLink resource.
string | number
{string} A string representing the entry_link.
matchEntryTypeFromEntryTypeName(entryTypeName)
matchEntryTypeFromEntryTypeName
(
entryTypeName
:
string
)
:
string
|
number
;
Parse the entry_type from EntryType resource.
entryTypeName
string
A fully-qualified path representing EntryType resource.
string | number
{string} A string representing the entry_type.
matchEnvironmentFromEnvironmentName(environmentName)
matchEnvironmentFromEnvironmentName
(
environmentName
:
string
)
:
string
|
number
;
Parse the environment from Environment resource.
environmentName
string
A fully-qualified path representing Environment resource.
string | number
{string} A string representing the environment.
matchEnvironmentFromSessionName(sessionName)
matchEnvironmentFromSessionName
(
sessionName
:
string
)
:
string
|
number
;
Parse the environment from Session resource.
sessionName
string
A fully-qualified path representing Session resource.
string | number
{string} A string representing the environment.
matchGlossaryCategoryFromGlossaryCategoryName(glossaryCategoryName)
matchGlossaryCategoryFromGlossaryCategoryName
(
glossaryCategoryName
:
string
)
:
string
|
number
;
Parse the glossary_category from GlossaryCategory resource.
glossaryCategoryName
string
A fully-qualified path representing GlossaryCategory resource.
string | number
{string} A string representing the glossary_category.
matchGlossaryFromGlossaryCategoryName(glossaryCategoryName)
matchGlossaryFromGlossaryCategoryName
(
glossaryCategoryName
:
string
)
:
string
|
number
;
Parse the glossary from GlossaryCategory resource.
glossaryCategoryName
string
A fully-qualified path representing GlossaryCategory resource.
string | number
{string} A string representing the glossary.
matchGlossaryFromGlossaryName(glossaryName)
matchGlossaryFromGlossaryName
(
glossaryName
:
string
)
:
string
|
number
;
Parse the glossary from Glossary resource.
glossaryName
string
A fully-qualified path representing Glossary resource.
string | number
{string} A string representing the glossary.
matchGlossaryFromGlossaryTermName(glossaryTermName)
matchGlossaryFromGlossaryTermName
(
glossaryTermName
:
string
)
:
string
|
number
;
Parse the glossary from GlossaryTerm resource.
glossaryTermName
string
A fully-qualified path representing GlossaryTerm resource.
string | number
{string} A string representing the glossary.
matchGlossaryTermFromGlossaryTermName(glossaryTermName)
matchGlossaryTermFromGlossaryTermName
(
glossaryTermName
:
string
)
:
string
|
number
;
Parse the glossary_term from GlossaryTerm resource.
glossaryTermName
string
A fully-qualified path representing GlossaryTerm resource.
string | number
{string} A string representing the glossary_term.
matchJobFromDataScanJobName(dataScanJobName)
matchJobFromDataScanJobName
(
dataScanJobName
:
string
)
:
string
|
number
;
Parse the job from DataScanJob resource.
dataScanJobName
string
A fully-qualified path representing DataScanJob resource.
string | number
{string} A string representing the job.
matchJobFromJobName(jobName)
matchJobFromJobName
(
jobName
:
string
)
:
string
|
number
;
Parse the job from Job resource.
jobName
string
A fully-qualified path representing Job resource.
string | number
{string} A string representing the job.
matchLakeFromAssetName(assetName)
matchLakeFromAssetName
(
assetName
:
string
)
:
string
|
number
;
Parse the lake from Asset resource.
assetName
string
A fully-qualified path representing Asset resource.
string | number
{string} A string representing the lake.
matchLakeFromContentName(contentName)
matchLakeFromContentName
(
contentName
:
string
)
:
string
|
number
;
Parse the lake from Content resource.
contentName
string
A fully-qualified path representing Content resource.
string | number
{string} A string representing the lake.
matchLakeFromEntityName(entityName)
matchLakeFromEntityName
(
entityName
:
string
)
:
string
|
number
;
Parse the lake from Entity resource.
entityName
string
A fully-qualified path representing Entity resource.
string | number
{string} A string representing the lake.
matchLakeFromEnvironmentName(environmentName)
matchLakeFromEnvironmentName
(
environmentName
:
string
)
:
string
|
number
;
Parse the lake from Environment resource.
environmentName
string
A fully-qualified path representing Environment resource.
string | number
{string} A string representing the lake.
matchLakeFromJobName(jobName)
matchLakeFromJobName
(
jobName
:
string
)
:
string
|
number
;
Parse the lake from Job resource.
jobName
string
A fully-qualified path representing Job resource.
string | number
{string} A string representing the lake.
matchLakeFromLakeName(lakeName)
matchLakeFromLakeName
(
lakeName
:
string
)
:
string
|
number
;
Parse the lake from Lake resource.
lakeName
string
A fully-qualified path representing Lake resource.
string | number
{string} A string representing the lake.
matchLakeFromPartitionName(partitionName)
matchLakeFromPartitionName
(
partitionName
:
string
)
:
string
|
number
;
Parse the lake from Partition resource.
partitionName
string
A fully-qualified path representing Partition resource.
string | number
{string} A string representing the lake.
matchLakeFromProjectLocationLakeActionName(projectLocationLakeActionName)
matchLakeFromProjectLocationLakeActionName
(
projectLocationLakeActionName
:
string
)
:
string
|
number
;
Parse the lake from ProjectLocationLakeAction resource.
projectLocationLakeActionName
string
A fully-qualified path representing project_location_lake_action resource.
string | number
{string} A string representing the lake.
matchLakeFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)
matchLakeFromProjectLocationLakeZoneActionName
(
projectLocationLakeZoneActionName
:
string
)
:
string
|
number
;
Parse the lake from ProjectLocationLakeZoneAction resource.
projectLocationLakeZoneActionName
string
A fully-qualified path representing project_location_lake_zone_action resource.
string | number
{string} A string representing the lake.
matchLakeFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)
matchLakeFromProjectLocationLakeZoneAssetActionName
(
projectLocationLakeZoneAssetActionName
:
string
)
:
string
|
number
;
Parse the lake from ProjectLocationLakeZoneAssetAction resource.
projectLocationLakeZoneAssetActionName
string
A fully-qualified path representing project_location_lake_zone_asset_action resource.
string | number
{string} A string representing the lake.
matchLakeFromSessionName(sessionName)
matchLakeFromSessionName
(
sessionName
:
string
)
:
string
|
number
;
Parse the lake from Session resource.
sessionName
string
A fully-qualified path representing Session resource.
string | number
{string} A string representing the lake.
matchLakeFromTaskName(taskName)
matchLakeFromTaskName
(
taskName
:
string
)
:
string
|
number
;
Parse the lake from Task resource.
taskName
string
A fully-qualified path representing Task resource.
string | number
{string} A string representing the lake.
matchLakeFromZoneName(zoneName)
matchLakeFromZoneName
(
zoneName
:
string
)
:
string
|
number
;
Parse the lake from Zone resource.
zoneName
string
A fully-qualified path representing Zone resource.
string | number
{string} A string representing the lake.
matchLocationFromAspectTypeName(aspectTypeName)
matchLocationFromAspectTypeName
(
aspectTypeName
:
string
)
:
string
|
number
;
Parse the location from AspectType resource.
aspectTypeName
string
A fully-qualified path representing AspectType resource.
string | number
{string} A string representing the location.
matchLocationFromAssetName(assetName)
matchLocationFromAssetName
(
assetName
:
string
)
:
string
|
number
;
Parse the location from Asset resource.
assetName
string
A fully-qualified path representing Asset resource.
string | number
{string} A string representing the location.
matchLocationFromContentName(contentName)
matchLocationFromContentName
(
contentName
:
string
)
:
string
|
number
;
Parse the location from Content resource.
contentName
string
A fully-qualified path representing Content resource.
string | number
{string} A string representing the location.
matchLocationFromDataAssetName(dataAssetName)
matchLocationFromDataAssetName
(
dataAssetName
:
string
)
:
string
|
number
;
Parse the location from DataAsset resource.
dataAssetName
string
A fully-qualified path representing DataAsset resource.
string | number
{string} A string representing the location.
matchLocationFromDataAttributeBindingName(dataAttributeBindingName)
matchLocationFromDataAttributeBindingName
(
dataAttributeBindingName
:
string
)
:
string
|
number
;
Parse the location from DataAttributeBinding resource.
dataAttributeBindingName
string
A fully-qualified path representing DataAttributeBinding resource.
string | number
{string} A string representing the location.
matchLocationFromDataAttributeName(dataAttributeName)
matchLocationFromDataAttributeName
(
dataAttributeName
:
string
)
:
string
|
number
;
Parse the location from DataAttribute resource.
dataAttributeName
string
A fully-qualified path representing DataAttribute resource.
string | number
{string} A string representing the location.
matchLocationFromDataProductName(dataProductName)
matchLocationFromDataProductName
(
dataProductName
:
string
)
:
string
|
number
;
Parse the location from DataProduct resource.
dataProductName
string
A fully-qualified path representing DataProduct resource.
string | number
{string} A string representing the location.
matchLocationFromDataScanJobName(dataScanJobName)
matchLocationFromDataScanJobName
(
dataScanJobName
:
string
)
:
string
|
number
;
Parse the location from DataScanJob resource.
dataScanJobName
string
A fully-qualified path representing DataScanJob resource.
string | number
{string} A string representing the location.
matchLocationFromDataScanName(dataScanName)
matchLocationFromDataScanName
(
dataScanName
:
string
)
:
string
|
number
;
Parse the location from DataScan resource.
dataScanName
string
A fully-qualified path representing DataScan resource.
string | number
{string} A string representing the location.
matchLocationFromDataTaxonomyName(dataTaxonomyName)
matchLocationFromDataTaxonomyName
(
dataTaxonomyName
:
string
)
:
string
|
number
;
Parse the location from DataTaxonomy resource.
dataTaxonomyName
string
A fully-qualified path representing DataTaxonomy resource.
string | number
{string} A string representing the location.
matchLocationFromEncryptionConfigName(encryptionConfigName)
matchLocationFromEncryptionConfigName
(
encryptionConfigName
:
string
)
:
string
|
number
;
Parse the location from EncryptionConfig resource.
encryptionConfigName
string
A fully-qualified path representing EncryptionConfig resource.
string | number
{string} A string representing the location.
matchLocationFromEntityName(entityName)
matchLocationFromEntityName
(
entityName
:
string
)
:
string
|
number
;
Parse the location from Entity resource.
entityName
string
A fully-qualified path representing Entity resource.
string | number
{string} A string representing the location.
matchLocationFromEntryGroupName(entryGroupName)
matchLocationFromEntryGroupName
(
entryGroupName
:
string
)
:
string
|
number
;
Parse the location from EntryGroup resource.
entryGroupName
string
A fully-qualified path representing EntryGroup resource.
string | number
{string} A string representing the location.
matchLocationFromEntryLinkName(entryLinkName)
matchLocationFromEntryLinkName
(
entryLinkName
:
string
)
:
string
|
number
;
Parse the location from EntryLink resource.
entryLinkName
string
A fully-qualified path representing EntryLink resource.
string | number
{string} A string representing the location.
matchLocationFromEntryName(entryName)
matchLocationFromEntryName
(
entryName
:
string
)
:
string
|
number
;
Parse the location from Entry resource.
entryName
string
A fully-qualified path representing Entry resource.
string | number
{string} A string representing the location.
matchLocationFromEntryTypeName(entryTypeName)
matchLocationFromEntryTypeName
(
entryTypeName
:
string
)
:
string
|
number
;
Parse the location from EntryType resource.
entryTypeName
string
A fully-qualified path representing EntryType resource.
string | number
{string} A string representing the location.
matchLocationFromEnvironmentName(environmentName)
matchLocationFromEnvironmentName
(
environmentName
:
string
)
:
string
|
number
;
Parse the location from Environment resource.
environmentName
string
A fully-qualified path representing Environment resource.
string | number
{string} A string representing the location.
matchLocationFromGlossaryCategoryName(glossaryCategoryName)
matchLocationFromGlossaryCategoryName
(
glossaryCategoryName
:
string
)
:
string
|
number
;
Parse the location from GlossaryCategory resource.
glossaryCategoryName
string
A fully-qualified path representing GlossaryCategory resource.
string | number
{string} A string representing the location.
matchLocationFromGlossaryName(glossaryName)
matchLocationFromGlossaryName
(
glossaryName
:
string
)
:
string
|
number
;
Parse the location from Glossary resource.
glossaryName
string
A fully-qualified path representing Glossary resource.
string | number
{string} A string representing the location.
matchLocationFromGlossaryTermName(glossaryTermName)
matchLocationFromGlossaryTermName
(
glossaryTermName
:
string
)
:
string
|
number
;
Parse the location from GlossaryTerm resource.
glossaryTermName
string
A fully-qualified path representing GlossaryTerm resource.
string | number
{string} A string representing the location.
matchLocationFromJobName(jobName)
matchLocationFromJobName
(
jobName
:
string
)
:
string
|
number
;
Parse the location from Job resource.
jobName
string
A fully-qualified path representing Job resource.
string | number
{string} A string representing the location.
matchLocationFromLakeName(lakeName)
matchLocationFromLakeName
(
lakeName
:
string
)
:
string
|
number
;
Parse the location from Lake resource.
lakeName
string
A fully-qualified path representing Lake resource.
string | number
{string} A string representing the location.
matchLocationFromLocationName(locationName)
matchLocationFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the location from Location resource.
locationName
string
A fully-qualified path representing Location resource.
string | number
{string} A string representing the location.
matchLocationFromMetadataFeedName(metadataFeedName)
matchLocationFromMetadataFeedName
(
metadataFeedName
:
string
)
:
string
|
number
;
Parse the location from MetadataFeed resource.
metadataFeedName
string
A fully-qualified path representing MetadataFeed resource.
string | number
{string} A string representing the location.
matchLocationFromMetadataJobName(metadataJobName)
matchLocationFromMetadataJobName
(
metadataJobName
:
string
)
:
string
|
number
;
Parse the location from MetadataJob resource.
metadataJobName
string
A fully-qualified path representing MetadataJob resource.
string | number
{string} A string representing the location.
matchLocationFromPartitionName(partitionName)
matchLocationFromPartitionName
(
partitionName
:
string
)
:
string
|
number
;
Parse the location from Partition resource.
partitionName
string
A fully-qualified path representing Partition resource.
string | number
{string} A string representing the location.
matchLocationFromProjectLocationLakeActionName(projectLocationLakeActionName)
matchLocationFromProjectLocationLakeActionName
(
projectLocationLakeActionName
:
string
)
:
string
|
number
;
Parse the location from ProjectLocationLakeAction resource.
projectLocationLakeActionName
string
A fully-qualified path representing project_location_lake_action resource.
string | number
{string} A string representing the location.
matchLocationFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)
matchLocationFromProjectLocationLakeZoneActionName
(
projectLocationLakeZoneActionName
:
string
)
:
string
|
number
;
Parse the location from ProjectLocationLakeZoneAction resource.
projectLocationLakeZoneActionName
string
A fully-qualified path representing project_location_lake_zone_action resource.
string | number
{string} A string representing the location.
matchLocationFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)
matchLocationFromProjectLocationLakeZoneAssetActionName
(
projectLocationLakeZoneAssetActionName
:
string
)
:
string
|
number
;
Parse the location from ProjectLocationLakeZoneAssetAction resource.
projectLocationLakeZoneAssetActionName
string
A fully-qualified path representing project_location_lake_zone_asset_action resource.
string | number
{string} A string representing the location.
matchLocationFromSessionName(sessionName)
matchLocationFromSessionName
(
sessionName
:
string
)
:
string
|
number
;
Parse the location from Session resource.
sessionName
string
A fully-qualified path representing Session resource.
string | number
{string} A string representing the location.
matchLocationFromTaskName(taskName)
matchLocationFromTaskName
(
taskName
:
string
)
:
string
|
number
;
Parse the location from Task resource.
taskName
string
A fully-qualified path representing Task resource.
string | number
{string} A string representing the location.
matchLocationFromZoneName(zoneName)
matchLocationFromZoneName
(
zoneName
:
string
)
:
string
|
number
;
Parse the location from Zone resource.
zoneName
string
A fully-qualified path representing Zone resource.
string | number
{string} A string representing the location.
matchMetadataFeedFromMetadataFeedName(metadataFeedName)
matchMetadataFeedFromMetadataFeedName
(
metadataFeedName
:
string
)
:
string
|
number
;
Parse the metadata_feed from MetadataFeed resource.
metadataFeedName
string
A fully-qualified path representing MetadataFeed resource.
string | number
{string} A string representing the metadata_feed.
matchMetadataJobFromMetadataJobName(metadataJobName)
matchMetadataJobFromMetadataJobName
(
metadataJobName
:
string
)
:
string
|
number
;
Parse the metadataJob from MetadataJob resource.
metadataJobName
string
A fully-qualified path representing MetadataJob resource.
string | number
{string} A string representing the metadataJob.
matchOrganizationFromEncryptionConfigName(encryptionConfigName)
matchOrganizationFromEncryptionConfigName
(
encryptionConfigName
:
string
)
:
string
|
number
;
Parse the organization from EncryptionConfig resource.
encryptionConfigName
string
A fully-qualified path representing EncryptionConfig resource.
string | number
{string} A string representing the organization.
matchPartitionFromPartitionName(partitionName)
matchPartitionFromPartitionName
(
partitionName
:
string
)
:
string
|
number
;
Parse the partition from Partition resource.
partitionName
string
A fully-qualified path representing Partition resource.
string | number
{string} A string representing the partition.
matchProjectFromAspectTypeName(aspectTypeName)
matchProjectFromAspectTypeName
(
aspectTypeName
:
string
)
:
string
|
number
;
Parse the project from AspectType resource.
aspectTypeName
string
A fully-qualified path representing AspectType resource.
string | number
{string} A string representing the project.
matchProjectFromAssetName(assetName)
matchProjectFromAssetName
(
assetName
:
string
)
:
string
|
number
;
Parse the project from Asset resource.
assetName
string
A fully-qualified path representing Asset resource.
string | number
{string} A string representing the project.
matchProjectFromContentName(contentName)
matchProjectFromContentName
(
contentName
:
string
)
:
string
|
number
;
Parse the project from Content resource.
contentName
string
A fully-qualified path representing Content resource.
string | number
{string} A string representing the project.
matchProjectFromDataAssetName(dataAssetName)
matchProjectFromDataAssetName
(
dataAssetName
:
string
)
:
string
|
number
;
Parse the project from DataAsset resource.
dataAssetName
string
A fully-qualified path representing DataAsset resource.
string | number
{string} A string representing the project.
matchProjectFromDataAttributeBindingName(dataAttributeBindingName)
matchProjectFromDataAttributeBindingName
(
dataAttributeBindingName
:
string
)
:
string
|
number
;
Parse the project from DataAttributeBinding resource.
dataAttributeBindingName
string
A fully-qualified path representing DataAttributeBinding resource.
string | number
{string} A string representing the project.
matchProjectFromDataAttributeName(dataAttributeName)
matchProjectFromDataAttributeName
(
dataAttributeName
:
string
)
:
string
|
number
;
Parse the project from DataAttribute resource.
dataAttributeName
string
A fully-qualified path representing DataAttribute resource.
string | number
{string} A string representing the project.
matchProjectFromDataProductName(dataProductName)
matchProjectFromDataProductName
(
dataProductName
:
string
)
:
string
|
number
;
Parse the project from DataProduct resource.
dataProductName
string
A fully-qualified path representing DataProduct resource.
string | number
{string} A string representing the project.
matchProjectFromDataScanJobName(dataScanJobName)
matchProjectFromDataScanJobName
(
dataScanJobName
:
string
)
:
string
|
number
;
Parse the project from DataScanJob resource.
dataScanJobName
string
A fully-qualified path representing DataScanJob resource.
string | number
{string} A string representing the project.
matchProjectFromDataScanName(dataScanName)
matchProjectFromDataScanName
(
dataScanName
:
string
)
:
string
|
number
;
Parse the project from DataScan resource.
dataScanName
string
A fully-qualified path representing DataScan resource.
string | number
{string} A string representing the project.
matchProjectFromDataTaxonomyName(dataTaxonomyName)
matchProjectFromDataTaxonomyName
(
dataTaxonomyName
:
string
)
:
string
|
number
;
Parse the project from DataTaxonomy resource.
dataTaxonomyName
string
A fully-qualified path representing DataTaxonomy resource.
string | number
{string} A string representing the project.
matchProjectFromEntityName(entityName)
matchProjectFromEntityName
(
entityName
:
string
)
:
string
|
number
;
Parse the project from Entity resource.
entityName
string
A fully-qualified path representing Entity resource.
string | number
{string} A string representing the project.
matchProjectFromEntryGroupName(entryGroupName)
matchProjectFromEntryGroupName
(
entryGroupName
:
string
)
:
string
|
number
;
Parse the project from EntryGroup resource.
entryGroupName
string
A fully-qualified path representing EntryGroup resource.
string | number
{string} A string representing the project.
matchProjectFromEntryLinkName(entryLinkName)
matchProjectFromEntryLinkName
(
entryLinkName
:
string
)
:
string
|
number
;
Parse the project from EntryLink resource.
entryLinkName
string
A fully-qualified path representing EntryLink resource.
string | number
{string} A string representing the project.
matchProjectFromEntryName(entryName)
matchProjectFromEntryName
(
entryName
:
string
)
:
string
|
number
;
Parse the project from Entry resource.
entryName
string
A fully-qualified path representing Entry resource.
string | number
{string} A string representing the project.
matchProjectFromEntryTypeName(entryTypeName)
matchProjectFromEntryTypeName
(
entryTypeName
:
string
)
:
string
|
number
;
Parse the project from EntryType resource.
entryTypeName
string
A fully-qualified path representing EntryType resource.
string | number
{string} A string representing the project.
matchProjectFromEnvironmentName(environmentName)
matchProjectFromEnvironmentName
(
environmentName
:
string
)
:
string
|
number
;
Parse the project from Environment resource.
environmentName
string
A fully-qualified path representing Environment resource.
string | number
{string} A string representing the project.
matchProjectFromGlossaryCategoryName(glossaryCategoryName)
matchProjectFromGlossaryCategoryName
(
glossaryCategoryName
:
string
)
:
string
|
number
;
Parse the project from GlossaryCategory resource.
glossaryCategoryName
string
A fully-qualified path representing GlossaryCategory resource.
string | number
{string} A string representing the project.
matchProjectFromGlossaryName(glossaryName)
matchProjectFromGlossaryName
(
glossaryName
:
string
)
:
string
|
number
;
Parse the project from Glossary resource.
glossaryName
string
A fully-qualified path representing Glossary resource.
string | number
{string} A string representing the project.
matchProjectFromGlossaryTermName(glossaryTermName)
matchProjectFromGlossaryTermName
(
glossaryTermName
:
string
)
:
string
|
number
;
Parse the project from GlossaryTerm resource.
glossaryTermName
string
A fully-qualified path representing GlossaryTerm resource.
string | number
{string} A string representing the project.
matchProjectFromJobName(jobName)
matchProjectFromJobName
(
jobName
:
string
)
:
string
|
number
;
Parse the project from Job resource.
jobName
string
A fully-qualified path representing Job resource.
string | number
{string} A string representing the project.
matchProjectFromLakeName(lakeName)
matchProjectFromLakeName
(
lakeName
:
string
)
:
string
|
number
;
Parse the project from Lake resource.
lakeName
string
A fully-qualified path representing Lake resource.
string | number
{string} A string representing the project.
matchProjectFromLocationName(locationName)
matchProjectFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the project from Location resource.
locationName
string
A fully-qualified path representing Location resource.
string | number
{string} A string representing the project.
matchProjectFromMetadataFeedName(metadataFeedName)
matchProjectFromMetadataFeedName
(
metadataFeedName
:
string
)
:
string
|
number
;
Parse the project from MetadataFeed resource.
metadataFeedName
string
A fully-qualified path representing MetadataFeed resource.
string | number
{string} A string representing the project.
matchProjectFromMetadataJobName(metadataJobName)
matchProjectFromMetadataJobName
(
metadataJobName
:
string
)
:
string
|
number
;
Parse the project from MetadataJob resource.
metadataJobName
string
A fully-qualified path representing MetadataJob resource.
string | number
{string} A string representing the project.
matchProjectFromPartitionName(partitionName)
matchProjectFromPartitionName
(
partitionName
:
string
)
:
string
|
number
;
Parse the project from Partition resource.
partitionName
string
A fully-qualified path representing Partition resource.
string | number
{string} A string representing the project.
matchProjectFromProjectLocationLakeActionName(projectLocationLakeActionName)
matchProjectFromProjectLocationLakeActionName
(
projectLocationLakeActionName
:
string
)
:
string
|
number
;
Parse the project from ProjectLocationLakeAction resource.
projectLocationLakeActionName
string
A fully-qualified path representing project_location_lake_action resource.
string | number
{string} A string representing the project.
matchProjectFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)
matchProjectFromProjectLocationLakeZoneActionName
(
projectLocationLakeZoneActionName
:
string
)
:
string
|
number
;
Parse the project from ProjectLocationLakeZoneAction resource.
projectLocationLakeZoneActionName
string
A fully-qualified path representing project_location_lake_zone_action resource.
string | number
{string} A string representing the project.
matchProjectFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)
matchProjectFromProjectLocationLakeZoneAssetActionName
(
projectLocationLakeZoneAssetActionName
:
string
)
:
string
|
number
;
Parse the project from ProjectLocationLakeZoneAssetAction resource.
projectLocationLakeZoneAssetActionName
string
A fully-qualified path representing project_location_lake_zone_asset_action resource.
string | number
{string} A string representing the project.
matchProjectFromSessionName(sessionName)
matchProjectFromSessionName
(
sessionName
:
string
)
:
string
|
number
;
Parse the project from Session resource.
sessionName
string
A fully-qualified path representing Session resource.
string | number
{string} A string representing the project.
matchProjectFromTaskName(taskName)
matchProjectFromTaskName
(
taskName
:
string
)
:
string
|
number
;
Parse the project from Task resource.
taskName
string
A fully-qualified path representing Task resource.
string | number
{string} A string representing the project.
matchProjectFromZoneName(zoneName)
matchProjectFromZoneName
(
zoneName
:
string
)
:
string
|
number
;
Parse the project from Zone resource.
zoneName
string
A fully-qualified path representing Zone resource.
string | number
{string} A string representing the project.
matchSessionFromSessionName(sessionName)
matchSessionFromSessionName
(
sessionName
:
string
)
:
string
|
number
;
Parse the session from Session resource.
sessionName
string
A fully-qualified path representing Session resource.
string | number
{string} A string representing the session.
matchTaskFromJobName(jobName)
matchTaskFromJobName
(
jobName
:
string
)
:
string
|
number
;
Parse the task from Job resource.
jobName
string
A fully-qualified path representing Job resource.
string | number
{string} A string representing the task.
matchTaskFromTaskName(taskName)
matchTaskFromTaskName
(
taskName
:
string
)
:
string
|
number
;
Parse the task from Task resource.
taskName
string
A fully-qualified path representing Task resource.
string | number
{string} A string representing the task.
matchZoneFromAssetName(assetName)
matchZoneFromAssetName
(
assetName
:
string
)
:
string
|
number
;
Parse the zone from Asset resource.
assetName
string
A fully-qualified path representing Asset resource.
string | number
{string} A string representing the zone.
matchZoneFromEntityName(entityName)
matchZoneFromEntityName
(
entityName
:
string
)
:
string
|
number
;
Parse the zone from Entity resource.
entityName
string
A fully-qualified path representing Entity resource.
string | number
{string} A string representing the zone.
matchZoneFromPartitionName(partitionName)
matchZoneFromPartitionName
(
partitionName
:
string
)
:
string
|
number
;
Parse the zone from Partition resource.
partitionName
string
A fully-qualified path representing Partition resource.
string | number
{string} A string representing the zone.
matchZoneFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)
matchZoneFromProjectLocationLakeZoneActionName
(
projectLocationLakeZoneActionName
:
string
)
:
string
|
number
;
Parse the zone from ProjectLocationLakeZoneAction resource.
projectLocationLakeZoneActionName
string
A fully-qualified path representing project_location_lake_zone_action resource.
string | number
{string} A string representing the zone.
matchZoneFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)
matchZoneFromProjectLocationLakeZoneAssetActionName
(
projectLocationLakeZoneAssetActionName
:
string
)
:
string
|
number
;
Parse the zone from ProjectLocationLakeZoneAssetAction resource.
projectLocationLakeZoneAssetActionName
string
A fully-qualified path representing project_location_lake_zone_asset_action resource.
string | number
{string} A string representing the zone.
matchZoneFromZoneName(zoneName)
matchZoneFromZoneName
(
zoneName
:
string
)
:
string
|
number
;
Parse the zone from Zone resource.
zoneName
string
A fully-qualified path representing Zone resource.
string | number
{string} A string representing the zone.
metadataFeedPath(project, location, metadataFeed)
metadataFeedPath
(
project
:
string
,
location
:
string
,
metadataFeed
:
string
)
:
string
;
Return a fully-qualified metadataFeed resource name string.
project
string
location
string
metadataFeed
string
string
{string} Resource name string.
metadataJobPath(project, location, metadataJob)
metadataJobPath
(
project
:
string
,
location
:
string
,
metadataJob
:
string
)
:
string
;
Return a fully-qualified metadataJob resource name string.
project
string
location
string
metadataJob
string
string
{string} Resource name string.
partitionPath(project, location, lake, zone, entity, partition)
partitionPath
(
project
:
string
,
location
:
string
,
lake
:
string
,
zone
:
string
,
entity
:
string
,
partition
:
string
)
:
string
;
Return a fully-qualified partition resource name string.
project
string
location
string
lake
string
zone
string
entity
string
partition
string
string
{string} Resource name string.
projectLocationLakeActionPath(project, location, lake, action)
projectLocationLakeActionPath
(
project
:
string
,
location
:
string
,
lake
:
string
,
action
:
string
)
:
string
;
Return a fully-qualified projectLocationLakeAction resource name string.
project
string
location
string
lake
string
action
string
string
{string} Resource name string.
projectLocationLakeZoneActionPath(project, location, lake, zone, action)
projectLocationLakeZoneActionPath
(
project
:
string
,
location
:
string
,
lake
:
string
,
zone
:
string
,
action
:
string
)
:
string
;
Return a fully-qualified projectLocationLakeZoneAction resource name string.
project
string
location
string
lake
string
zone
string
action
string
string
{string} Resource name string.
projectLocationLakeZoneAssetActionPath(project, location, lake, zone, asset, action)
projectLocationLakeZoneAssetActionPath
(
project
:
string
,
location
:
string
,
lake
:
string
,
zone
:
string
,
asset
:
string
,
action
:
string
)
:
string
;
Return a fully-qualified projectLocationLakeZoneAssetAction resource name string.
project
string
location
string
lake
string
zone
string
asset
string
action
string
string
{string} Resource name string.
sessionPath(project, location, lake, environment, session)
sessionPath
(
project
:
string
,
location
:
string
,
lake
:
string
,
environment
:
string
,
session
:
string
)
:
string
;
Return a fully-qualified session resource name string.
project
string
location
string
lake
string
environment
string
session
string
string
{string} Resource name string.
taskPath(project, location, lake, task)
taskPath
(
project
:
string
,
location
:
string
,
lake
:
string
,
task
:
string
)
:
string
;
Return a fully-qualified task resource name string.
project
string
location
string
lake
string
task
string
string
{string} Resource name string.
updateDataAsset(request, options)
updateDataAsset
(
request
?:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IUpdateDataAssetRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataAsset
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Updates a data asset.
request
options
Promise
<[ LROperation
< protos.google.cloud.dataplex.v1.IDataAsset
, protos.google.cloud.dataplex.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the documentation
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 data asset to update.
* The data asset's `name` field is used to identify the data asset to update.
*/
// const dataAsset = {}
/**
* Optional. The list of fields to update.
* If this is empty or not set, then all the fields will be updated.
*/
// const updateMask = {}
/**
* Optional. Validates the request without actually updating the data asset.
* Defaults to false.
*/
// const validateOnly = true
// Imports the Dataplex library
const
{
DataProductServiceClient
}
=
require
(
' @google-cloud/dataplex
'
).
v1
;
// Instantiates a client
const
dataplexClient
=
new
DataProductServiceClient
();
async
function
callUpdateDataAsset
()
{
// Construct request
const
request
=
{
dataAsset
,
};
// Run request
const
[
operation
]
=
await
dataplexClient
.
updateDataAsset
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callUpdateDataAsset
();
updateDataAsset(request, options, callback)
updateDataAsset
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IUpdateDataAssetRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataAsset
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< LROperation
< protos.google.cloud.dataplex.v1.IDataAsset
, protos.google.cloud.dataplex.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
updateDataAsset(request, callback)
updateDataAsset
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IUpdateDataAssetRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataAsset
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< LROperation
< protos.google.cloud.dataplex.v1.IDataAsset
, protos.google.cloud.dataplex.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
updateDataProduct(request, options)
updateDataProduct
(
request
?:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IUpdateDataProductRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataProduct
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Updates a data product.
request
options
Promise
<[ LROperation
< protos.google.cloud.dataplex.v1.IDataProduct
, protos.google.cloud.dataplex.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the documentation
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 data product to update.
* The data product's `name` field is used to identify the data product to
* update.
*/
// const dataProduct = {}
/**
* Optional. The list of fields to update.
* If this is empty or not set, then all the fields will be updated.
*/
// const updateMask = {}
/**
* Optional. Validates the request without actually updating the data product.
* Default: false.
*/
// const validateOnly = true
// Imports the Dataplex library
const
{
DataProductServiceClient
}
=
require
(
' @google-cloud/dataplex
'
).
v1
;
// Instantiates a client
const
dataplexClient
=
new
DataProductServiceClient
();
async
function
callUpdateDataProduct
()
{
// Construct request
const
request
=
{
dataProduct
,
};
// Run request
const
[
operation
]
=
await
dataplexClient
.
updateDataProduct
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callUpdateDataProduct
();
updateDataProduct(request, options, callback)
updateDataProduct
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IUpdateDataProductRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataProduct
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< LROperation
< protos.google.cloud.dataplex.v1.IDataProduct
, protos.google.cloud.dataplex.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
updateDataProduct(request, callback)
updateDataProduct
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IUpdateDataProductRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataProduct
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< LROperation
< protos.google.cloud.dataplex.v1.IDataProduct
, protos.google.cloud.dataplex.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
zonePath(project, location, lake, zone)
zonePath
(
project
:
string
,
location
:
string
,
lake
:
string
,
zone
:
string
)
:
string
;
Return a fully-qualified zone resource name string.
project
string
location
string
lake
string
zone
string
string
{string} Resource name string.
