databricks.DataQualityRefresh
This resource allows you to refresh the data quality monitoring checks on Unity Catalog tables.
You must either:
- be an owner of the table’s parent catalog, have USE_SCHEMA on the table’s parent schema, and have SELECT access on the table
- have USE_CATALOG on the table’s parent catalog, be an owner of the table’s parent schema, and have SELECT access on the table.
- have the following permissions:
- USE_CATALOG on the table’s parent catalog
- USE_SCHEMA on the table’s parent schema
- be an owner of the table.
Note This resource can only be used with a workspace-level provider!
Example Usage
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
resources:
sandbox:
type: databricks:Catalog
properties:
name: sandbox
comment: this catalog is managed by terraform
properties:
purpose: testing
myTestSchema:
type: databricks:Schema
properties:
catalogName: ${sandbox.id}
name: myTestSchema
comment: this database is managed by terraform
properties:
kind: various
myTestTable:
type: databricks:SqlTable
properties:
catalogName: main
schemaName: ${myTestSchema.name}
name: bar
tableType: MANAGED
dataSourceFormat: DELTA
columns:
- name: timestamp
type: int
this:
type: databricks:DataQualityMonitor
properties:
objectType: table
objectId: ${myTestTable.id}
dataProfilingConfig:
output_schema: ${myTestSchema.schemaId}
thisDataQualityRefresh:
type: databricks:DataQualityRefresh
name: this
properties:
objectType: table
objectId: ${myTestTable.id}
Create DataQualityRefresh Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DataQualityRefresh(name: string, args: DataQualityRefreshArgs, opts?: CustomResourceOptions);@overload
def DataQualityRefresh(resource_name: str,
args: DataQualityRefreshArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DataQualityRefresh(resource_name: str,
opts: Optional[ResourceOptions] = None,
object_id: Optional[str] = None,
object_type: Optional[str] = None)func NewDataQualityRefresh(ctx *Context, name string, args DataQualityRefreshArgs, opts ...ResourceOption) (*DataQualityRefresh, error)public DataQualityRefresh(string name, DataQualityRefreshArgs args, CustomResourceOptions? opts = null)
public DataQualityRefresh(String name, DataQualityRefreshArgs args)
public DataQualityRefresh(String name, DataQualityRefreshArgs args, CustomResourceOptions options)
type: databricks:DataQualityRefresh
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args DataQualityRefreshArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DataQualityRefreshArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DataQualityRefreshArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DataQualityRefreshArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DataQualityRefreshArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var dataQualityRefreshResource = new Databricks.DataQualityRefresh("dataQualityRefreshResource", new()
{
ObjectId = "string",
ObjectType = "string",
});
example, err := databricks.NewDataQualityRefresh(ctx, "dataQualityRefreshResource", &databricks.DataQualityRefreshArgs{
ObjectId: pulumi.String("string"),
ObjectType: pulumi.String("string"),
})
var dataQualityRefreshResource = new DataQualityRefresh("dataQualityRefreshResource", DataQualityRefreshArgs.builder()
.objectId("string")
.objectType("string")
.build());
data_quality_refresh_resource = databricks.DataQualityRefresh("dataQualityRefreshResource",
object_id="string",
object_type="string")
const dataQualityRefreshResource = new databricks.DataQualityRefresh("dataQualityRefreshResource", {
objectId: "string",
objectType: "string",
});
type: databricks:DataQualityRefresh
properties:
objectId: string
objectType: string
DataQualityRefresh Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The DataQualityRefresh resource accepts the following input properties:
- Object
Id string The UUID of the request object. It is
schema_idforschema, andtable_idfortable.Find the
schema_idfrom either:- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
Schemasresource. - In Catalog Explorer > select the
schema> go to theDetailstab > theSchema IDfield.
Find the
table_idfrom either:- The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the
Tablesresource. - In Catalog Explorer > select the
table> go to theDetailstab > theTable IDfield
- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
- Object
Type string - The type of the monitored object. Can be one of the following:
schemaortable
- Object
Id string The UUID of the request object. It is
schema_idforschema, andtable_idfortable.Find the
schema_idfrom either:- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
Schemasresource. - In Catalog Explorer > select the
schema> go to theDetailstab > theSchema IDfield.
Find the
table_idfrom either:- The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the
Tablesresource. - In Catalog Explorer > select the
table> go to theDetailstab > theTable IDfield
- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
- Object
Type string - The type of the monitored object. Can be one of the following:
schemaortable
- object
Id String The UUID of the request object. It is
schema_idforschema, andtable_idfortable.Find the
schema_idfrom either:- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
Schemasresource. - In Catalog Explorer > select the
schema> go to theDetailstab > theSchema IDfield.
Find the
table_idfrom either:- The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the
Tablesresource. - In Catalog Explorer > select the
table> go to theDetailstab > theTable IDfield
- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
- object
Type String - The type of the monitored object. Can be one of the following:
schemaortable
- object
Id string The UUID of the request object. It is
schema_idforschema, andtable_idfortable.Find the
schema_idfrom either:- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
Schemasresource. - In Catalog Explorer > select the
schema> go to theDetailstab > theSchema IDfield.
Find the
table_idfrom either:- The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the
Tablesresource. - In Catalog Explorer > select the
table> go to theDetailstab > theTable IDfield
- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
- object
Type string - The type of the monitored object. Can be one of the following:
schemaortable
- object_
id str The UUID of the request object. It is
schema_idforschema, andtable_idfortable.Find the
schema_idfrom either:- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
Schemasresource. - In Catalog Explorer > select the
schema> go to theDetailstab > theSchema IDfield.
Find the
table_idfrom either:- The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the
Tablesresource. - In Catalog Explorer > select the
table> go to theDetailstab > theTable IDfield
- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
- object_
type str - The type of the monitored object. Can be one of the following:
schemaortable
- object
Id String The UUID of the request object. It is
schema_idforschema, andtable_idfortable.Find the
schema_idfrom either:- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
Schemasresource. - In Catalog Explorer > select the
schema> go to theDetailstab > theSchema IDfield.
Find the
table_idfrom either:- The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the
Tablesresource. - In Catalog Explorer > select the
table> go to theDetailstab > theTable IDfield
- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
- object
Type String - The type of the monitored object. Can be one of the following:
schemaortable
Outputs
All input properties are implicitly available as output properties. Additionally, the DataQualityRefresh resource produces the following output properties:
- End
Time intMs - (integer) - Time when the refresh ended (milliseconds since 1/1/1970 UTC)
- Id string
- The provider-assigned unique ID for this managed resource.
- Message string
- (string) - An optional message to give insight into the current state of the refresh (e.g. FAILURE messages)
- Refresh
Id int - (integer) - Unique id of the refresh operation
- Start
Time intMs - (integer) - Time when the refresh started (milliseconds since 1/1/1970 UTC)
- State string
- (string) - The current state of the refresh. Possible values are:
MONITOR_REFRESH_STATE_CANCELED,MONITOR_REFRESH_STATE_FAILED,MONITOR_REFRESH_STATE_PENDING,MONITOR_REFRESH_STATE_RUNNING,MONITOR_REFRESH_STATE_SUCCESS,MONITOR_REFRESH_STATE_UNKNOWN - Trigger string
- (string) - What triggered the refresh. Possible values are:
MONITOR_REFRESH_TRIGGER_DATA_CHANGE,MONITOR_REFRESH_TRIGGER_MANUAL,MONITOR_REFRESH_TRIGGER_SCHEDULE,MONITOR_REFRESH_TRIGGER_UNKNOWN
- End
Time intMs - (integer) - Time when the refresh ended (milliseconds since 1/1/1970 UTC)
- Id string
- The provider-assigned unique ID for this managed resource.
- Message string
- (string) - An optional message to give insight into the current state of the refresh (e.g. FAILURE messages)
- Refresh
Id int - (integer) - Unique id of the refresh operation
- Start
Time intMs - (integer) - Time when the refresh started (milliseconds since 1/1/1970 UTC)
- State string
- (string) - The current state of the refresh. Possible values are:
MONITOR_REFRESH_STATE_CANCELED,MONITOR_REFRESH_STATE_FAILED,MONITOR_REFRESH_STATE_PENDING,MONITOR_REFRESH_STATE_RUNNING,MONITOR_REFRESH_STATE_SUCCESS,MONITOR_REFRESH_STATE_UNKNOWN - Trigger string
- (string) - What triggered the refresh. Possible values are:
MONITOR_REFRESH_TRIGGER_DATA_CHANGE,MONITOR_REFRESH_TRIGGER_MANUAL,MONITOR_REFRESH_TRIGGER_SCHEDULE,MONITOR_REFRESH_TRIGGER_UNKNOWN
- end
Time IntegerMs - (integer) - Time when the refresh ended (milliseconds since 1/1/1970 UTC)
- id String
- The provider-assigned unique ID for this managed resource.
- message String
- (string) - An optional message to give insight into the current state of the refresh (e.g. FAILURE messages)
- refresh
Id Integer - (integer) - Unique id of the refresh operation
- start
Time IntegerMs - (integer) - Time when the refresh started (milliseconds since 1/1/1970 UTC)
- state String
- (string) - The current state of the refresh. Possible values are:
MONITOR_REFRESH_STATE_CANCELED,MONITOR_REFRESH_STATE_FAILED,MONITOR_REFRESH_STATE_PENDING,MONITOR_REFRESH_STATE_RUNNING,MONITOR_REFRESH_STATE_SUCCESS,MONITOR_REFRESH_STATE_UNKNOWN - trigger String
- (string) - What triggered the refresh. Possible values are:
MONITOR_REFRESH_TRIGGER_DATA_CHANGE,MONITOR_REFRESH_TRIGGER_MANUAL,MONITOR_REFRESH_TRIGGER_SCHEDULE,MONITOR_REFRESH_TRIGGER_UNKNOWN
- end
Time numberMs - (integer) - Time when the refresh ended (milliseconds since 1/1/1970 UTC)
- id string
- The provider-assigned unique ID for this managed resource.
- message string
- (string) - An optional message to give insight into the current state of the refresh (e.g. FAILURE messages)
- refresh
Id number - (integer) - Unique id of the refresh operation
- start
Time numberMs - (integer) - Time when the refresh started (milliseconds since 1/1/1970 UTC)
- state string
- (string) - The current state of the refresh. Possible values are:
MONITOR_REFRESH_STATE_CANCELED,MONITOR_REFRESH_STATE_FAILED,MONITOR_REFRESH_STATE_PENDING,MONITOR_REFRESH_STATE_RUNNING,MONITOR_REFRESH_STATE_SUCCESS,MONITOR_REFRESH_STATE_UNKNOWN - trigger string
- (string) - What triggered the refresh. Possible values are:
MONITOR_REFRESH_TRIGGER_DATA_CHANGE,MONITOR_REFRESH_TRIGGER_MANUAL,MONITOR_REFRESH_TRIGGER_SCHEDULE,MONITOR_REFRESH_TRIGGER_UNKNOWN
- end_
time_ intms - (integer) - Time when the refresh ended (milliseconds since 1/1/1970 UTC)
- id str
- The provider-assigned unique ID for this managed resource.
- message str
- (string) - An optional message to give insight into the current state of the refresh (e.g. FAILURE messages)
- refresh_
id int - (integer) - Unique id of the refresh operation
- start_
time_ intms - (integer) - Time when the refresh started (milliseconds since 1/1/1970 UTC)
- state str
- (string) - The current state of the refresh. Possible values are:
MONITOR_REFRESH_STATE_CANCELED,MONITOR_REFRESH_STATE_FAILED,MONITOR_REFRESH_STATE_PENDING,MONITOR_REFRESH_STATE_RUNNING,MONITOR_REFRESH_STATE_SUCCESS,MONITOR_REFRESH_STATE_UNKNOWN - trigger str
- (string) - What triggered the refresh. Possible values are:
MONITOR_REFRESH_TRIGGER_DATA_CHANGE,MONITOR_REFRESH_TRIGGER_MANUAL,MONITOR_REFRESH_TRIGGER_SCHEDULE,MONITOR_REFRESH_TRIGGER_UNKNOWN
- end
Time NumberMs - (integer) - Time when the refresh ended (milliseconds since 1/1/1970 UTC)
- id String
- The provider-assigned unique ID for this managed resource.
- message String
- (string) - An optional message to give insight into the current state of the refresh (e.g. FAILURE messages)
- refresh
Id Number - (integer) - Unique id of the refresh operation
- start
Time NumberMs - (integer) - Time when the refresh started (milliseconds since 1/1/1970 UTC)
- state String
- (string) - The current state of the refresh. Possible values are:
MONITOR_REFRESH_STATE_CANCELED,MONITOR_REFRESH_STATE_FAILED,MONITOR_REFRESH_STATE_PENDING,MONITOR_REFRESH_STATE_RUNNING,MONITOR_REFRESH_STATE_SUCCESS,MONITOR_REFRESH_STATE_UNKNOWN - trigger String
- (string) - What triggered the refresh. Possible values are:
MONITOR_REFRESH_TRIGGER_DATA_CHANGE,MONITOR_REFRESH_TRIGGER_MANUAL,MONITOR_REFRESH_TRIGGER_SCHEDULE,MONITOR_REFRESH_TRIGGER_UNKNOWN
Look up Existing DataQualityRefresh Resource
Get an existing DataQualityRefresh resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: DataQualityRefreshState, opts?: CustomResourceOptions): DataQualityRefresh@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
end_time_ms: Optional[int] = None,
message: Optional[str] = None,
object_id: Optional[str] = None,
object_type: Optional[str] = None,
refresh_id: Optional[int] = None,
start_time_ms: Optional[int] = None,
state: Optional[str] = None,
trigger: Optional[str] = None) -> DataQualityRefreshfunc GetDataQualityRefresh(ctx *Context, name string, id IDInput, state *DataQualityRefreshState, opts ...ResourceOption) (*DataQualityRefresh, error)public static DataQualityRefresh Get(string name, Input<string> id, DataQualityRefreshState? state, CustomResourceOptions? opts = null)public static DataQualityRefresh get(String name, Output<String> id, DataQualityRefreshState state, CustomResourceOptions options)resources: _: type: databricks:DataQualityRefresh get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- End
Time intMs - (integer) - Time when the refresh ended (milliseconds since 1/1/1970 UTC)
- Message string
- (string) - An optional message to give insight into the current state of the refresh (e.g. FAILURE messages)
- Object
Id string The UUID of the request object. It is
schema_idforschema, andtable_idfortable.Find the
schema_idfrom either:- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
Schemasresource. - In Catalog Explorer > select the
schema> go to theDetailstab > theSchema IDfield.
Find the
table_idfrom either:- The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the
Tablesresource. - In Catalog Explorer > select the
table> go to theDetailstab > theTable IDfield
- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
- Object
Type string - The type of the monitored object. Can be one of the following:
schemaortable - Refresh
Id int - (integer) - Unique id of the refresh operation
- Start
Time intMs - (integer) - Time when the refresh started (milliseconds since 1/1/1970 UTC)
- State string
- (string) - The current state of the refresh. Possible values are:
MONITOR_REFRESH_STATE_CANCELED,MONITOR_REFRESH_STATE_FAILED,MONITOR_REFRESH_STATE_PENDING,MONITOR_REFRESH_STATE_RUNNING,MONITOR_REFRESH_STATE_SUCCESS,MONITOR_REFRESH_STATE_UNKNOWN - Trigger string
- (string) - What triggered the refresh. Possible values are:
MONITOR_REFRESH_TRIGGER_DATA_CHANGE,MONITOR_REFRESH_TRIGGER_MANUAL,MONITOR_REFRESH_TRIGGER_SCHEDULE,MONITOR_REFRESH_TRIGGER_UNKNOWN
- End
Time intMs - (integer) - Time when the refresh ended (milliseconds since 1/1/1970 UTC)
- Message string
- (string) - An optional message to give insight into the current state of the refresh (e.g. FAILURE messages)
- Object
Id string The UUID of the request object. It is
schema_idforschema, andtable_idfortable.Find the
schema_idfrom either:- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
Schemasresource. - In Catalog Explorer > select the
schema> go to theDetailstab > theSchema IDfield.
Find the
table_idfrom either:- The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the
Tablesresource. - In Catalog Explorer > select the
table> go to theDetailstab > theTable IDfield
- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
- Object
Type string - The type of the monitored object. Can be one of the following:
schemaortable - Refresh
Id int - (integer) - Unique id of the refresh operation
- Start
Time intMs - (integer) - Time when the refresh started (milliseconds since 1/1/1970 UTC)
- State string
- (string) - The current state of the refresh. Possible values are:
MONITOR_REFRESH_STATE_CANCELED,MONITOR_REFRESH_STATE_FAILED,MONITOR_REFRESH_STATE_PENDING,MONITOR_REFRESH_STATE_RUNNING,MONITOR_REFRESH_STATE_SUCCESS,MONITOR_REFRESH_STATE_UNKNOWN - Trigger string
- (string) - What triggered the refresh. Possible values are:
MONITOR_REFRESH_TRIGGER_DATA_CHANGE,MONITOR_REFRESH_TRIGGER_MANUAL,MONITOR_REFRESH_TRIGGER_SCHEDULE,MONITOR_REFRESH_TRIGGER_UNKNOWN
- end
Time IntegerMs - (integer) - Time when the refresh ended (milliseconds since 1/1/1970 UTC)
- message String
- (string) - An optional message to give insight into the current state of the refresh (e.g. FAILURE messages)
- object
Id String The UUID of the request object. It is
schema_idforschema, andtable_idfortable.Find the
schema_idfrom either:- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
Schemasresource. - In Catalog Explorer > select the
schema> go to theDetailstab > theSchema IDfield.
Find the
table_idfrom either:- The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the
Tablesresource. - In Catalog Explorer > select the
table> go to theDetailstab > theTable IDfield
- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
- object
Type String - The type of the monitored object. Can be one of the following:
schemaortable - refresh
Id Integer - (integer) - Unique id of the refresh operation
- start
Time IntegerMs - (integer) - Time when the refresh started (milliseconds since 1/1/1970 UTC)
- state String
- (string) - The current state of the refresh. Possible values are:
MONITOR_REFRESH_STATE_CANCELED,MONITOR_REFRESH_STATE_FAILED,MONITOR_REFRESH_STATE_PENDING,MONITOR_REFRESH_STATE_RUNNING,MONITOR_REFRESH_STATE_SUCCESS,MONITOR_REFRESH_STATE_UNKNOWN - trigger String
- (string) - What triggered the refresh. Possible values are:
MONITOR_REFRESH_TRIGGER_DATA_CHANGE,MONITOR_REFRESH_TRIGGER_MANUAL,MONITOR_REFRESH_TRIGGER_SCHEDULE,MONITOR_REFRESH_TRIGGER_UNKNOWN
- end
Time numberMs - (integer) - Time when the refresh ended (milliseconds since 1/1/1970 UTC)
- message string
- (string) - An optional message to give insight into the current state of the refresh (e.g. FAILURE messages)
- object
Id string The UUID of the request object. It is
schema_idforschema, andtable_idfortable.Find the
schema_idfrom either:- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
Schemasresource. - In Catalog Explorer > select the
schema> go to theDetailstab > theSchema IDfield.
Find the
table_idfrom either:- The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the
Tablesresource. - In Catalog Explorer > select the
table> go to theDetailstab > theTable IDfield
- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
- object
Type string - The type of the monitored object. Can be one of the following:
schemaortable - refresh
Id number - (integer) - Unique id of the refresh operation
- start
Time numberMs - (integer) - Time when the refresh started (milliseconds since 1/1/1970 UTC)
- state string
- (string) - The current state of the refresh. Possible values are:
MONITOR_REFRESH_STATE_CANCELED,MONITOR_REFRESH_STATE_FAILED,MONITOR_REFRESH_STATE_PENDING,MONITOR_REFRESH_STATE_RUNNING,MONITOR_REFRESH_STATE_SUCCESS,MONITOR_REFRESH_STATE_UNKNOWN - trigger string
- (string) - What triggered the refresh. Possible values are:
MONITOR_REFRESH_TRIGGER_DATA_CHANGE,MONITOR_REFRESH_TRIGGER_MANUAL,MONITOR_REFRESH_TRIGGER_SCHEDULE,MONITOR_REFRESH_TRIGGER_UNKNOWN
- end_
time_ intms - (integer) - Time when the refresh ended (milliseconds since 1/1/1970 UTC)
- message str
- (string) - An optional message to give insight into the current state of the refresh (e.g. FAILURE messages)
- object_
id str The UUID of the request object. It is
schema_idforschema, andtable_idfortable.Find the
schema_idfrom either:- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
Schemasresource. - In Catalog Explorer > select the
schema> go to theDetailstab > theSchema IDfield.
Find the
table_idfrom either:- The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the
Tablesresource. - In Catalog Explorer > select the
table> go to theDetailstab > theTable IDfield
- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
- object_
type str - The type of the monitored object. Can be one of the following:
schemaortable - refresh_
id int - (integer) - Unique id of the refresh operation
- start_
time_ intms - (integer) - Time when the refresh started (milliseconds since 1/1/1970 UTC)
- state str
- (string) - The current state of the refresh. Possible values are:
MONITOR_REFRESH_STATE_CANCELED,MONITOR_REFRESH_STATE_FAILED,MONITOR_REFRESH_STATE_PENDING,MONITOR_REFRESH_STATE_RUNNING,MONITOR_REFRESH_STATE_SUCCESS,MONITOR_REFRESH_STATE_UNKNOWN - trigger str
- (string) - What triggered the refresh. Possible values are:
MONITOR_REFRESH_TRIGGER_DATA_CHANGE,MONITOR_REFRESH_TRIGGER_MANUAL,MONITOR_REFRESH_TRIGGER_SCHEDULE,MONITOR_REFRESH_TRIGGER_UNKNOWN
- end
Time NumberMs - (integer) - Time when the refresh ended (milliseconds since 1/1/1970 UTC)
- message String
- (string) - An optional message to give insight into the current state of the refresh (e.g. FAILURE messages)
- object
Id String The UUID of the request object. It is
schema_idforschema, andtable_idfortable.Find the
schema_idfrom either:- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
Schemasresource. - In Catalog Explorer > select the
schema> go to theDetailstab > theSchema IDfield.
Find the
table_idfrom either:- The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the
Tablesresource. - In Catalog Explorer > select the
table> go to theDetailstab > theTable IDfield
- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
- object
Type String - The type of the monitored object. Can be one of the following:
schemaortable - refresh
Id Number - (integer) - Unique id of the refresh operation
- start
Time NumberMs - (integer) - Time when the refresh started (milliseconds since 1/1/1970 UTC)
- state String
- (string) - The current state of the refresh. Possible values are:
MONITOR_REFRESH_STATE_CANCELED,MONITOR_REFRESH_STATE_FAILED,MONITOR_REFRESH_STATE_PENDING,MONITOR_REFRESH_STATE_RUNNING,MONITOR_REFRESH_STATE_SUCCESS,MONITOR_REFRESH_STATE_UNKNOWN - trigger String
- (string) - What triggered the refresh. Possible values are:
MONITOR_REFRESH_TRIGGER_DATA_CHANGE,MONITOR_REFRESH_TRIGGER_MANUAL,MONITOR_REFRESH_TRIGGER_SCHEDULE,MONITOR_REFRESH_TRIGGER_UNKNOWN
Import
As of Pulumi v1.5, resources can be imported through configuration.
hcl
import {
id = “object_type,object_id,refresh_id”
to = databricks_data_quality_refresh.this
}
If you are using an older version of Pulumi, import the resource using the pulumi import command as follows:
$ pulumi import databricks:index/dataQualityRefresh:DataQualityRefresh this "object_type,object_id,refresh_id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- databricks pulumi/pulumi-databricks
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
databricksTerraform Provider.
