Ascend Client Method Summary

Method	Description	Matching HTTP Request
create_component_group	create component group in dataflow	POST /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/groups
create_connection	create connection	POST /api/v1/organizations/{data_service_id}/connections
create_container_image	create a container image definition	POST /api/v1/envs/container_images
create_data_feed	create data feed in dataflow	POST /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/pubs
create_data_feed_connector	create a data feed connector in dataflow	POST /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/subs
create_dataflow	create dataflow	POST /api/v1/organizations/{data_service_id}/projects
create_data_service	create data service	POST /api/v1/organizations
create_data_service_credentials	create data service credentials	POST /api/v1/organizations/{data_service_id}/vault
create_read_connector	create read connector in dataflow	POST /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/sources
create_site_connection	create a connection at the site level	POST /api/v1/connections
create_site_credentials	create site-level credentials	POST /api/v1/credentials/vault
create_spark_cluster_pool	create a spark cluster pool	POST /api/v1/envs/spark_cluster_pools
create_transform	create transform in dataflow	POST /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/views
create_write_connector	create write connector in dataflow	POST /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/sinks
delete_component_group	delete component group in dataflow	DELETE /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/groups/{id}
delete_connection	delete connection	DELETE /api/v1/organizations/{data_service_id}/connections/{connection_id}
delete_container_image	delete container image definition by label	DELETE /api/v1/envs/container_images/{label}
delete_data_feed	delete data feed in dataflow	DELETE /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/pubs/{id}
delete_data_feed_connector	delete data feed connector in dataflow	DELETE /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/subs/{id}
delete_dataflow	delete dataflow	dataDELETE /api/v1/organizations/{data_service_id}/projects/{dataflow_id}
delete_data_service	delete data service	DELETE /api/v1/organizations/{data_service_id}
delete_data_service_credentials	delete credentials by id	DELETE /api/v1/organizations/{data_service_id}/vault/{credential_id}
delete_read_connector	delete read connector in dataflow	DELETE /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/sources/{id}
delete_site_connection	delete site-level connection	DELETE /api/v1/connections/{connection_id}
delete_site_credentials	delete site-level credentials by id	DELETE /api/v1/credentials/vault/{credential_id}
delete_spark_cluster_pool	delete spark cluster pool by uuid	DELETE /api/v1/envs/spark_cluster_pools/{uuid}
delete_transform	delete transform in dataflow	DELETE /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/views/{id}
delete_write_connector	delete write connector in dataflow	DELETE /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/sinks/{id}
download_logs	download log archive for component	GET /api/v1/logs/download
get_ascend_version	Get Ascend version information	GET /api/v1/version
get_component_group	get component group in dataflow	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/groups/{id}
get_connection	get connection	GET /api/v1/organizations/{data_service_id}/connections/{connection_id}
get_connection_type	get connection type	GET /api/v1/organizations/{data_service_id}/connection_types/{connection_type_id}
get_container_image	get container image definition by label	GET /api/v1/envs/container_images/{label}
get_data_feed	get data feed in dataflow	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/pubs/{id}
get_data_feed_connector	get data feed connector in dataflow	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/subs/{id}
get_data_feed_connector_partitions	get data feed connector partitions	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/subs/{id}/partitions
get_data_feed_connector_records	get data feed connector records	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/subs/{id}/records
get_data_feed_connector_schema	get data feed connector schema	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/subs/{id}/schema
get_data_feed_connector_state	get data feed connector state	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/subs/{id}/state
get_data_feed_connector_statistics	get data feed connector statistics	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/subs/{id}/statistics
get_data_feed_for_data_feed_connector	get input data feed for a data feed connector	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/subs/{id}/pub
get_data_feed_partitions	get data feed partitions	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/pubs/{id}/partitions
get_data_feed_records	get data feed records	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/pubs/{id}/records
get_data_feed_schema	get data feed schema	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/pubs/{id}/schema
get_data_feed_state	get data feed state	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/pubs/{id}/state
get_data_feed_statistics	get data feed statistics	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/pubs/{id}/statistics
get_dataflow	get dataflow	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}
get_dataflow_data_plane_config	get data plane configuration of a dataflow	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/dataplane_configuration
get_data_service	get data service	GET /api/v1/organizations/{data_service_id}
get_data_service_data_plane_config	get data plane configuration of a data service	GET /api/v1/organizations/{data_service_id}/dataplane_configuration
get_data_service_runtime_environment	get runtime environment of a data service	GET /api/v1/organizations/{data_service_id}/runtime_environment
get_env_config	get environment config	GET /api/v1/envs/env_config/{config_key}
get_logs	get logs for component	GET /api/v1/logs
get_read_connector	get read connector in dataflow	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/sources/{id}
get_read_connector_errors	get read connector errors	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/sources/{id}/errors
get_read_connector_lineage	get read connector lineage	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/sources/{id}/lineage
get_read_connector_partitions	get read connector partitions	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/sources/{id}/partitions
get_read_connector_quality_test_results	get read connector quality test results	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/sources/{id}/quality-test-results
get_read_connector_records	get read connector records	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/sources/{id}/records
get_read_connector_schema	get read connector schema	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/sources/{id}/schema
get_read_connector_state	get read connector state	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/sources/{id}/state
get_read_connector_statistics	get read connector statistics	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/sources/{id}/statistics
get_read_connector_warnings	get read connector warnings	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/sources/{id}/warnings
get_site_connection	get connection configured at the site level	GET /api/v1/connections/{connection_id}
get_spark_cluster_pool	get spark cluster pool by uuid	GET /api/v1/envs/spark_cluster_pools/{uuid}
get_spark_cluster_pool_status	get spark cluster pool status by uuid	GET /api/v1/envs/spark_cluster_pool_status/{uuid}
get_transform	get transform in dataflow	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/views/{id}
get_transform_errors	get transform errors	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/views/{id}/errors
get_transform_lineage	get transform lineage	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/views/{id}/lineage
get_transform_partitions	get transform partitions	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/views/{id}/partitions
get_transform_quality_test_results	get transform quality test results	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/views/{id}/quality-test-results
get_transform_records	get transform records	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/views/{id}/records
get_transform_schema	get transform schema	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/views/{id}/schema
get_transform_state	get transform state	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/views/{id}/state
get_transform_statistics	get transform statistics	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/views/{id}/statistics
get_transform_warnings	get transform warnings	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/views/{id}/warnings
get_write_connector	get write connector in dataflow	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/sinks/{id}
get_write_connector_errors	get write connector errors	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/sinks/{id}/errors
get_write_connector_lineage	get write connector lineage	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/sinks/{id}/lineage
get_write_connector_partitions	get write connector partitions	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/sinks/{id}/partitions
get_write_connector_state	get write connector state	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/sinks/{id}/state
get_write_connector_statistics	get write connector statistics	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/sinks/{id}/statistics
get_write_connector_warnings	get write connector warnings	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/sinks/{id}/warnings
list_component_groups	list component groups in a dataflow	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/groups
list_connections	List all connections in a data service	GET /api/v1/organizations/{data_service_id}/connections
list_connection_types	List all connection types in a data service	GET /api/v1/organizations/{data_service_id}/connection_types
list_container_images	list container image definitions	GET /api/v1/envs/container_images
list_data_feed_connectors	list data feed connectors in a dataflow	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/subs
list_data_feeds	list data feeds in a dataflow	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/pubs
list_dataflow_components	list components in a dataflow	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/components
list_dataflows	List all dataflows in a data service	GET /api/v1/organizations/{data_service_id}/projects
list_data_service_components	get list of components in a data service	GET /api/v1/organizations/{data_service_id}/components
list_data_service_credentials	list data service credentials	GET /api/v1/organizations/{data_service_id}/vault
list_data_service_roles	List all Data Service roles	GET /authz/v1/org_roles
list_data_services	List all Data Services	GET /api/v1/organizations
list_read_connectors	list read connectors in a dataflow	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/sources
list_site_connections	List all connections at the site level	GET /api/v1/connections
list_site_credentials	list all site-level credentials	GET /api/v1/credentials/vault
list_spark_cluster_pools	list spark cluster pools	GET /api/v1/envs/spark_cluster_pools
list_transforms	list transforms in a dataflow	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/views
list_write_connectors	list write connectors in a dataflow	GET /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/sinks
preview_connection	preview the schema and records of this connection	POST /api/v1/organizations/{data_service_id}/connections/{connection_id}/preview
refresh_read_connector	refresh read connector	POST /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/sources/{id}/refresh
reset_dataflow_errors	reset dataflow errors	POST /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/reset-errors
reset_read_connector_errors	reset read connector errors	POST /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/sources/{id}/reset-errors
reset_transform_errors	reset transform errors	POST /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/views/{id}/reset-errors
reset_write_connector_errors	reset write connector errors	POST /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/sinks/{id}/reset-errors
share_connection	share connection to another data service	POST /api/v1/organizations/{data_service_id}/connections/{connection_id}/share_to/{target_data_service_id}
update_component_group	update component group in dataflow	PATCH /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/groups/{component_group_id}
update_connection	update connection	PATCH /api/v1/organizations/{data_service_id}/connections/{connection_id_value}
update_container_image	update a container image definition	PATCH /api/v1/envs/container_images/{label}
update_data_feed	update data feed in dataflow	PATCH /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/pubs/{data_feed_id}
update_data_feed_connector	update data feed connector in dataflow	PATCH /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/subs/{data_feed_connector_id}
update_dataflow	update dataflow	PATCH /api/v1/organizations/{data_service_id}/projects/{dataflow_id}
update_dataflow_data_plane_config	update data plane configuration of a dataflow	PATCH /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/dataplane_configuration
update_data_service	update data service	PATCH /api/v1/organizations/{id}
update_data_service_credentials	update data service credentials	PATCH /api/v1/organizations/{data_service_id}/vault/{credential_id}
update_data_service_data_plane_config	update data plane configuration of a data service	PATCH /api/v1/organizations/{data_service_id}/dataplane_configuration
update_data_service_runtime_environment	update runtime environment of a data service	PATCH /api/v1/organizations/{data_service_id}/runtime_environment
update_read_connector	update read connector in dataflow	PATCH /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/sources/{read_connector_id}
update_read_connector_paused_state	pause or unpause a read connector	POST /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/sources/{id}/paused-state
update_site_connection	update connection at the site level	PATCH /api/v1/connections/{id_value}
update_site_credentials	update site-level credentials	PATCH /api/v1/credentials/vault/{credential_id}
update_spark_cluster_pool	update a spark cluster pool	PATCH /api/v1/envs/spark_cluster_pools/{uuid}
update_transform	update transform in dataflow	PATCH /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/views/{transform_id}
update_transform_paused_state	pause or unpause a transform	POST /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/views/{id}/paused-state
update_write_connector	update write connector in dataflow	PATCH /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/sinks/{write_connector_id}
update_write_connector_paused_state	pause or unpause a write connector	POST /api/v1/organizations/{data_service_id}/projects/{dataflow_id}/sinks/{id}/paused-state

Client Methods Breakdown

create_component_group

create component group in dataflow

Returns: ComponentGroupResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
body	ComponentGroup	Component group details.	True

[Back to top] [Back to API list] [Back to Models]

create_connection

create connection

Returns: CreateConnectionResponse

Parameters

Name	Type	Description	Required
data_service_id	string		True
body	Connection		True

[Back to top] [Back to API list] [Back to Models]

create_container_image

create a container image definition

Returns: ContainerImageResponse

Parameters

Name	Type	Description	Required
body	Spark.ContainerImage		True

[Back to top] [Back to API list] [Back to Models]

create_data_feed

create data feed in dataflow

Returns: DataFeedResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
body	DataFeed	Data feed details.	True

[Back to top] [Back to API list] [Back to Models]

create_data_feed_connector

create a data feed connector in dataflow

Returns: DataFeedConnectorResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
body	DataFeedConnector	Data feed connector details.	True

[Back to top] [Back to API list] [Back to Models]

create_dataflow

create dataflow

Returns: DataflowResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
body	Dataflow	Dataflow details.	True

[Back to top] [Back to API list] [Back to Models]

create_data_service

create data service

Returns: DataServiceResponse

Parameters

Name	Type	Description	Required
body	DataService		True

[Back to top] [Back to API list] [Back to Models]

create_data_service_credentials

create data service credentials

Returns: CredentialsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
body	Credentials	Component credentials.	True

[Back to top] [Back to API list] [Back to Models]

create_read_connector

create read connector in dataflow

Returns: ReadConnectorResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
body	ReadConnector	Read connector to be created/updated.	True

[Back to top] [Back to API list] [Back to Models]

create_site_connection

create a connection at the site level

Returns: CreateConnectionResponse

Parameters

Name	Type	Description	Required
body	Connection		True

[Back to top] [Back to API list] [Back to Models]

create_site_credentials

create site-level credentials

Returns: CredentialsResponse

Parameters

Name	Type	Description	Required
body	Credentials		True

[Back to top] [Back to API list] [Back to Models]

create_spark_cluster_pool

create a spark cluster pool

Returns: SparkClusterPoolResponse

Parameters

Name	Type	Description	Required
body	SparkClusterPool		True

[Back to top] [Back to API list] [Back to Models]

create_transform

create transform in dataflow

Returns: TransformResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
body	Transform	Transform details.	True

[Back to top] [Back to API list] [Back to Models]

create_write_connector

create write connector in dataflow

Returns: WriteConnectorResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
body	WriteConnector	Write connector details.	True

[Back to top] [Back to API list] [Back to Models]

delete_component_group

delete component group in dataflow

Returns: DeleteResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True

[Back to top] [Back to API list] [Back to Models]

delete_connection

delete connection

Returns: DeleteResponse

Parameters

Name	Type	Description	Required
data_service_id	string		True
connection_id	string		True

[Back to top] [Back to API list] [Back to Models]

delete_container_image

delete container image definition by label

Returns: ContainerImageDeleteResponse

Parameters

Name	Type	Description	Required
label	string	container label.	True

[Back to top] [Back to API list] [Back to Models]

delete_data_feed

delete data feed in dataflow

Returns: DeleteResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True

[Back to top] [Back to API list] [Back to Models]

delete_data_feed_connector

delete data feed connector in dataflow

Returns: DeleteResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True

[Back to top] [Back to API list] [Back to Models]

delete_dataflow

delete dataflow

Returns: DeleteResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True

[Back to top] [Back to API list] [Back to Models]

delete_data_service

delete data service

Returns: DeleteResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True

[Back to top] [Back to API list] [Back to Models]

delete_data_service_credentials

delete credentials by id

Returns: DeleteCredentialsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
credential_id	string	Credential id.	True

[Back to top] [Back to API list] [Back to Models]

delete_read_connector

delete read connector in dataflow

Returns: DeleteResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True

[Back to top] [Back to API list] [Back to Models]

delete_site_connection

delete site-level connection

Returns: DeleteResponse

Parameters

Name	Type	Description	Required
connection_id	string		True

[Back to top] [Back to API list] [Back to Models]

delete_site_credentials

delete site-level credentials by id

Returns: DeleteCredentialsResponse

Parameters

Name	Type	Description	Required
credential_id	string		True

[Back to top] [Back to API list] [Back to Models]

delete_spark_cluster_pool

delete spark cluster pool by uuid

Returns: SparkClusterPoolResponse

Parameters

Name	Type	Description	Required
uuid	string	cluster pool uuid.	True

[Back to top] [Back to API list] [Back to Models]

delete_transform

delete transform in dataflow

Returns: DeleteResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True

[Back to top] [Back to API list] [Back to Models]

delete_write_connector

delete write connector in dataflow

Returns: DeleteResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True

[Back to top] [Back to API list] [Back to Models]

download_logs

download log archive for component

Returns: object

Parameters

Name	Type	Description	Required
range_start	int64	start time in nanoseconds.	False
range_end	int64	end time in nanoseconds.	False
label	string	log label.	False
backward	boolean	log search direction, set to true to get most recent logs first.	False
jwt	string	jwt for validation.	False
limit	integer	max number of lines in result.	False
next_page_cursor	int64	cursor to get next page.	False

[Back to top] [Back to API list] [Back to Models]

get_ascend_version

Get Ascend version information

Returns: AscendVersionResponse

Parameters

This method does not need any parameters.

[Back to top] [Back to API list] [Back to Models]

get_component_group

get component group in dataflow

Returns: ComponentGroupResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True

[Back to top] [Back to API list] [Back to Models]

get_connection

get connection

Returns: ConnectionResponse

Parameters

Name	Type	Description	Required
data_service_id	string		True
connection_id	string		True

[Back to top] [Back to API list] [Back to Models]

get_connection_type

get connection type

Returns: ConnectionTypeResponse

Parameters

Name	Type	Description	Required
data_service_id	string		True
connection_type_id	string		True

[Back to top] [Back to API list] [Back to Models]

get_container_image

get container image definition by label

Returns: ContainerImageResponse

Parameters

Name	Type	Description	Required
label	string	container label.	True

[Back to top] [Back to API list] [Back to Models]

get_data_feed

get data feed in dataflow

Returns: DataFeedResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True

[Back to top] [Back to API list] [Back to Models]

get_data_feed_connector

get data feed connector in dataflow

Returns: DataFeedConnectorResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True

[Back to top] [Back to API list] [Back to Models]

get_data_feed_connector_partitions

get data feed connector partitions

Returns: ComponentPartitionsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True
stage	string		False
stage_index	integer		False
offset	integer	Offset in partition metadata list.	False
limit	integer	Upper limit of partition metadata results returned.	True
start_ts	int64		False
end_ts	int64		False

[Back to top] [Back to API list] [Back to Models]

get_data_feed_connector_records

get data feed connector records

Returns: ComponentRecordsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True
stage	string		False
stage_index	integer		False
offset	uint64	Record offset.	False
limit	int64	Upper limit of number of records to be returned.	True
token	string		False
format	string		False

[Back to top] [Back to API list] [Back to Models]

get_data_feed_connector_schema

get data feed connector schema

Returns: ComponentSchemaResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True

[Back to top] [Back to API list] [Back to Models]

get_data_feed_connector_state

get data feed connector state

Returns: ComponentStateResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True

[Back to top] [Back to API list] [Back to Models]

get_data_feed_connector_statistics

get data feed connector statistics

Returns: ComponentStatisticsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True
stage	string		False
stage_index	integer		False

[Back to top] [Back to API list] [Back to Models]

get_data_feed_for_data_feed_connector

get input data feed for a data feed connector

Returns: DataFeedResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True

[Back to top] [Back to API list] [Back to Models]

get_data_feed_partitions

get data feed partitions

Returns: ComponentPartitionsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True
stage	string		False
stage_index	integer		False
offset	integer	Offset in partition metadata list.	False
limit	integer	Upper limit of partition metadata results returned.	True
start_ts	int64		False
end_ts	int64		False

[Back to top] [Back to API list] [Back to Models]

get_data_feed_records

get data feed records

Returns: ComponentRecordsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True
stage	string		False
stage_index	integer		False
offset	uint64	Record offset.	False
limit	int64	Upper limit of number of records to be returned.	True
token	string		False
format	string		False

[Back to top] [Back to API list] [Back to Models]

get_data_feed_schema

get data feed schema

Returns: ComponentSchemaResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True

[Back to top] [Back to API list] [Back to Models]

get_data_feed_state

get data feed state

Returns: ComponentStateResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True

[Back to top] [Back to API list] [Back to Models]

get_data_feed_statistics

get data feed statistics

Returns: ComponentStatisticsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True
stage	string		False
stage_index	integer		False

[Back to top] [Back to API list] [Back to Models]

get_dataflow

get dataflow

Returns: DataflowResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True

[Back to top] [Back to API list] [Back to Models]

get_dataflow_data_plane_config

get data plane configuration of a dataflow

Returns: DataflowDataPlaneConfigResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True

[Back to top] [Back to API list] [Back to Models]

get_data_service

get data service

Returns: DataServiceResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True

[Back to top] [Back to API list] [Back to Models]

get_data_service_data_plane_config

get data plane configuration of a data service

Returns: DataServiceDataPlaneConfigResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True

[Back to top] [Back to API list] [Back to Models]

get_data_service_runtime_environment

get runtime environment of a data service

Returns: DataServiceRuntimeEnvironmentResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True

[Back to top] [Back to API list] [Back to Models]

get_env_config

get environment config

Returns: EnvConfigResponse

Parameters

Name	Type	Description	Required
config_key	string	config key, currently only support 'allowable_data_service_types'	True

[Back to top] [Back to API list] [Back to Models]

get_logs

get logs for component

Returns: ComponentLogsResponse

Parameters

Name	Type	Description	Required
range_start	int64	start time in nanoseconds.	False
range_end	int64	end time in nanoseconds.	False
label	string	log label.	False
backward	boolean	log search direction, set to true to get most recent logs first.	False
jwt	string	jwt for validation.	False
limit	integer	max number of lines in result.	False
next_page_cursor	int64	cursor to get next page.	False

[Back to top] [Back to API list] [Back to Models]

get_read_connector

get read connector in dataflow

Returns: ReadConnectorResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True

[Back to top] [Back to API list] [Back to Models]

get_read_connector_errors

get read connector errors

Returns: ComponentErrorsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True
offset	uint64	Offset in errors list.	False
limit	uint64	Upper limit of the number of errors returned.	True

[Back to top] [Back to API list] [Back to Models]

get_read_connector_lineage

get read connector lineage

Returns: ComponentLineageResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True

[Back to top] [Back to API list] [Back to Models]

get_read_connector_partitions

get read connector partitions

Returns: ComponentPartitionsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True
stage	string		False
stage_index	integer		False
offset	integer	Offset in partition metadata list.	False
limit	integer	Upper limit of partition metadata results returned.	True
start_ts	int64		False
end_ts	int64		False

[Back to top] [Back to API list] [Back to Models]

get_read_connector_quality_test_results

get read connector quality test results

Returns: ComponentQualityTestResultsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True

[Back to top] [Back to API list] [Back to Models]

get_read_connector_records

get read connector records

Returns: ComponentRecordsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True
stage	string		False
stage_index	integer		False
offset	uint64	Record offset.	False
limit	int64	Upper limit of number of records to be returned.	True
token	string		False
format	string		False

[Back to top] [Back to API list] [Back to Models]

get_read_connector_schema

get read connector schema

Returns: ComponentSchemaResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True

[Back to top] [Back to API list] [Back to Models]

get_read_connector_state

get read connector state

Returns: ComponentStateResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True

[Back to top] [Back to API list] [Back to Models]

get_read_connector_statistics

get read connector statistics

Returns: ComponentStatisticsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True
stage	string		False
stage_index	integer		False

[Back to top] [Back to API list] [Back to Models]

get_read_connector_warnings

get read connector warnings

Returns: ComponentWarningsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True
offset	uint64	Offset in errors list.	False
limit	uint64	Upper limit of the number of errors returned.	True

[Back to top] [Back to API list] [Back to Models]

get_site_connection

get connection configured at the site level

Returns: ConnectionResponse

Parameters

Name	Type	Description	Required
connection_id	string		True

[Back to top] [Back to API list] [Back to Models]

get_spark_cluster_pool

get spark cluster pool by uuid

Returns: SparkClusterPoolResponse

Parameters

Name	Type	Description	Required
uuid	string	cluster pool uuid.	True

[Back to top] [Back to API list] [Back to Models]

get_spark_cluster_pool_status

get spark cluster pool status by uuid

Returns: SparkClusterPoolStatusResponse

Parameters

Name	Type	Description	Required
uuid	string	cluster pool uuid.	True

[Back to top] [Back to API list] [Back to Models]

get_transform

get transform in dataflow

Returns: TransformResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True

[Back to top] [Back to API list] [Back to Models]

get_transform_errors

get transform errors

Returns: ComponentErrorsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True
offset	uint64	Offset in errors list.	False
limit	uint64	Upper limit of the number of errors returned.	True

[Back to top] [Back to API list] [Back to Models]

get_transform_lineage

get transform lineage

Returns: ComponentLineageResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True

[Back to top] [Back to API list] [Back to Models]

get_transform_partitions

get transform partitions

Returns: ComponentPartitionsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True
stage	string		False
stage_index	integer		False
offset	integer	Offset in partition metadata list.	False
limit	integer	Upper limit of partition metadata results returned.	True
start_ts	int64		False
end_ts	int64		False

[Back to top] [Back to API list] [Back to Models]

get_transform_quality_test_results

get transform quality test results

Returns: ComponentQualityTestResultsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True

[Back to top] [Back to API list] [Back to Models]

get_transform_records

get transform records

Returns: ComponentRecordsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True
stage	string		False
stage_index	integer		False
offset	uint64	Record offset.	False
limit	int64	Upper limit of number of records to be returned.	True
token	string		False
format	string		False

[Back to top] [Back to API list] [Back to Models]

get_transform_schema

get transform schema

Returns: ComponentSchemaResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True

[Back to top] [Back to API list] [Back to Models]

get_transform_state

get transform state

Returns: ComponentStateResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True

[Back to top] [Back to API list] [Back to Models]

get_transform_statistics

get transform statistics

Returns: ComponentStatisticsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True
stage	string		False
stage_index	integer		False

[Back to top] [Back to API list] [Back to Models]

get_transform_warnings

get transform warnings

Returns: ComponentWarningsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True
offset	uint64	Offset in errors list.	False
limit	uint64	Upper limit of the number of errors returned.	True

[Back to top] [Back to API list] [Back to Models]

get_write_connector

get write connector in dataflow

Returns: WriteConnectorResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True

[Back to top] [Back to API list] [Back to Models]

get_write_connector_errors

get write connector errors

Returns: ComponentErrorsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True
offset	uint64	Offset in errors list.	False
limit	uint64	Upper limit of the number of errors returned.	True

[Back to top] [Back to API list] [Back to Models]

get_write_connector_lineage

get write connector lineage

Returns: ComponentLineageResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True

[Back to top] [Back to API list] [Back to Models]

get_write_connector_partitions

get write connector partitions

Returns: ComponentPartitionsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True
stage	string		False
stage_index	integer		False
offset	integer	Offset in partition metadata list.	False
limit	integer	Upper limit of partition metadata results returned.	True
start_ts	int64		False
end_ts	int64		False

[Back to top] [Back to API list] [Back to Models]

get_write_connector_state

get write connector state

Returns: ComponentStateResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True

[Back to top] [Back to API list] [Back to Models]

get_write_connector_statistics

get write connector statistics

Returns: ComponentStatisticsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True
stage	string		False
stage_index	integer		False

[Back to top] [Back to API list] [Back to Models]

get_write_connector_warnings

get write connector warnings

Returns: ComponentWarningsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True
offset	uint64	Offset in errors list.	False
limit	uint64	Upper limit of the number of errors returned.	True

[Back to top] [Back to API list] [Back to Models]

list_component_groups

list component groups in a dataflow

Returns: ComponentGroupsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True

[Back to top] [Back to API list] [Back to Models]

list_connections

List all connections in a data service

Returns: ConnectionsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True

[Back to top] [Back to API list] [Back to Models]

list_connection_types

List all connection types in a data service

Returns: ConnectionTypesResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True

[Back to top] [Back to API list] [Back to Models]

list_container_images

list container image definitions

Returns: ContainerImagesResponse

Parameters

This method does not need any parameters.

[Back to top] [Back to API list] [Back to Models]

list_data_feed_connectors

list data feed connectors in a dataflow

Returns: DataFeedConnectorsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
deep	boolean	If set to true, populate the detailed source/view/sink fields in Component response, and not just top level Component fields.	False
state	string	Comma-separated list of component states to filter on - valid values are uptodate, running, outofdate, error.	False
kind	string	Comma-separated list of component types to filter on - valid values are source, view, sink, pub, sub, group. Note - these are legacy names for ReadConnector, Transform, WriteConnector, DataFeed, DataFeedConnector, ComponentGroup respectively.	False
summary	boolean		False

[Back to top] [Back to API list] [Back to Models]

list_data_feeds

list data feeds in a dataflow

Returns: DataFeedsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
deep	boolean	If set to true, populate the detailed source/view/sink fields in Component response, and not just top level Component fields.	False
state	string	Comma-separated list of component states to filter on - valid values are uptodate, running, outofdate, error.	False
kind	string	Comma-separated list of component types to filter on - valid values are source, view, sink, pub, sub, group. Note - these are legacy names for ReadConnector, Transform, WriteConnector, DataFeed, DataFeedConnector, ComponentGroup respectively.	False
summary	boolean		False

[Back to top] [Back to API list] [Back to Models]

list_dataflow_components

list components in a dataflow

Returns: ComponentsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
deep	boolean	If set to true, populate the detailed source/view/sink fields in Component response, and not just top level Component fields.	False
state	string	Comma-separated list of component states to filter on - valid values are uptodate, running, outofdate, error.	False
kind	string	Comma-separated list of component types to filter on - valid values are source, view, sink, pub, sub, group. Note - these are legacy names for ReadConnector, Transform, WriteConnector, DataFeed, DataFeedConnector, ComponentGroup respectively.	False
summary	boolean		False

[Back to top] [Back to API list] [Back to Models]

list_dataflows

List all dataflows in a data service

Returns: DataflowsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True

[Back to top] [Back to API list] [Back to Models]

list_data_service_components

get list of components in a data service

Returns: ComponentsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
deep	boolean	If set to true, populate the detailed source/view/sink fields in Component response, and not just top level Component fields.	False
state	string	Comma-separated list of component states to filter on - valid values are uptodate, running, outofdate, error.	False
kind	string	Comma-separated list of component types to filter on - valid values are source, view, sink, pub, sub, group. Note - these are legacy names for ReadConnector, Transform, WriteConnector, DataFeed, DataFeedConnector, ComponentGroup respectively.	False
summary	boolean		False

[Back to top] [Back to API list] [Back to Models]

list_data_service_credentials

list data service credentials

Returns: ListCredentialsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
component_hint	string		False

[Back to top] [Back to API list] [Back to Models]

list_data_service_roles

List all Data Service roles

Returns: DataServiceRolesResponse

Parameters

This method does not need any parameters.

[Back to top] [Back to API list] [Back to Models]

list_data_services

List all Data Services

Returns: DataServicesResponse

Parameters

This method does not need any parameters.

[Back to top] [Back to API list] [Back to Models]

list_read_connectors

list read connectors in a dataflow

Returns: ReadConnectorsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
deep	boolean	If set to true, populate the detailed source/view/sink fields in Component response, and not just top level Component fields.	False
state	string	Comma-separated list of component states to filter on - valid values are uptodate, running, outofdate, error.	False
kind	string	Comma-separated list of component types to filter on - valid values are source, view, sink, pub, sub, group. Note - these are legacy names for ReadConnector, Transform, WriteConnector, DataFeed, DataFeedConnector, ComponentGroup respectively.	False
summary	boolean		False

[Back to top] [Back to API list] [Back to Models]

list_site_connections

List all connections at the site level

Returns: ConnectionsResponse

Parameters

This method does not need any parameters.

[Back to top] [Back to API list] [Back to Models]

list_site_credentials

list all site-level credentials

Returns: ListCredentialsResponse

Parameters

This method does not need any parameters.

[Back to top] [Back to API list] [Back to Models]

list_spark_cluster_pools

list spark cluster pools

Returns: SparkClusterPoolsResponse

Parameters

This method does not need any parameters.

[Back to top] [Back to API list] [Back to Models]

list_transforms

list transforms in a dataflow

Returns: TransformsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
deep	boolean	If set to true, populate the detailed source/view/sink fields in Component response, and not just top level Component fields.	False
state	string	Comma-separated list of component states to filter on - valid values are uptodate, running, outofdate, error.	False
kind	string	Comma-separated list of component types to filter on - valid values are source, view, sink, pub, sub, group. Note - these are legacy names for ReadConnector, Transform, WriteConnector, DataFeed, DataFeedConnector, ComponentGroup respectively.	False
summary	boolean		False

[Back to top] [Back to API list] [Back to Models]

list_write_connectors

list write connectors in a dataflow

Returns: WriteConnectorsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
deep	boolean	If set to true, populate the detailed source/view/sink fields in Component response, and not just top level Component fields.	False
state	string	Comma-separated list of component states to filter on - valid values are uptodate, running, outofdate, error.	False
kind	string	Comma-separated list of component types to filter on - valid values are source, view, sink, pub, sub, group. Note - these are legacy names for ReadConnector, Transform, WriteConnector, DataFeed, DataFeedConnector, ComponentGroup respectively.	False
summary	boolean		False

[Back to top] [Back to API list] [Back to Models]

preview_connection

preview the schema and records of this connection

Returns: PreviewConnectionResponse

Parameters

Name	Type	Required
data_service_id	string	True
connection_id	string	True
body	Connection.Asset.Record	True

[Back to top] [Back to API list] [Back to Models]

refresh_read_connector

refresh read connector

Returns: ReadConnectorRefreshResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True

[Back to top] [Back to API list] [Back to Models]

reset_dataflow_errors

reset dataflow errors

Returns: DataflowErrorsResetResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
body	DataflowErrorsResetRequest.Options	Reset request options.	True

[Back to top] [Back to API list] [Back to Models]

reset_read_connector_errors

reset read connector errors

Returns: ComponentErrorsResetResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True
body	ComponentErrorsResetRequest.Options	Reset options.	True

[Back to top] [Back to API list] [Back to Models]

reset_transform_errors

reset transform errors

Returns: ComponentErrorsResetResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True
body	ComponentErrorsResetRequest.Options	Reset options.	True

[Back to top] [Back to API list] [Back to Models]

reset_write_connector_errors

reset write connector errors

Returns: ComponentErrorsResetResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True
body	ComponentErrorsResetRequest.Options	Reset options.	True

[Back to top] [Back to API list] [Back to Models]

share_connection

share connection to another data service

Returns: ShareConnectionResponse

Parameters

Name	Type	Required
data_service_id	string	True
connection_id	string	True
target_data_service_id	string	True

[Back to top] [Back to API list] [Back to Models]

update_component_group

update component group in dataflow

Returns: ComponentGroupResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
component_group_id	string	The unique identifier of this component group.	True
body	ComponentGroup	Component group details.	True

[Back to top] [Back to API list] [Back to Models]

update_connection

update connection

Returns: UpdateConnectionResponse

Parameters

Name	Type	Required
data_service_id	string	True
connection_id_value	string	True
body	Connection	True

[Back to top] [Back to API list] [Back to Models]

update_container_image

update a container image definition

Returns: ContainerImageResponse

Parameters

Name	Type	Description	Required
label	string	a unique reference to the image.	True
body	Spark.ContainerImage		True

[Back to top] [Back to API list] [Back to Models]

update_data_feed

update data feed in dataflow

Returns: DataFeedResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
data_feed_id	string	The unique identifier of this data feed.	True
body	DataFeed	Data feed details.	True

[Back to top] [Back to API list] [Back to Models]

update_data_feed_connector

update data feed connector in dataflow

Returns: DataFeedConnectorResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
data_feed_connector_id	string	The unique identifier of this data feed connector.	True
body	DataFeedConnector	Data feed connector details.	True

[Back to top] [Back to API list] [Back to Models]

update_dataflow

update dataflow

Returns: DataflowResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	The unique identifier of this dataflow.	True
body	Dataflow	Dataflow details.	True

[Back to top] [Back to API list] [Back to Models]

update_dataflow_data_plane_config

update data plane configuration of a dataflow

Returns: DataflowDataPlaneConfigResponse

Parameters

Name	Type	Description	Required
data_service_id	string	data service id.	True
dataflow_id	string	dataflow id.	True
body	DataPlaneConfig	data plane config for the dataflow.	True

[Back to top] [Back to API list] [Back to Models]

update_data_service

update data service

Returns: DataServiceResponse

Parameters

Name	Type	Description	Required
id	string	The unique identifier of this data service.	True
body	DataService		True

[Back to top] [Back to API list] [Back to Models]

update_data_service_credentials

update data service credentials

Returns: CredentialsResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
credential_id	string	Credential id.	True
body	Credentials	Component credentials.	True

[Back to top] [Back to API list] [Back to Models]

update_data_service_data_plane_config

update data plane configuration of a data service

Returns: DataServiceDataPlaneConfigResponse

Parameters

Name	Type	Description	Required
data_service_id	string	data service id.	True
body	DataPlaneConfig	data plane config for the data service.	True

[Back to top] [Back to API list] [Back to Models]

update_data_service_runtime_environment

update runtime environment of a data service

Returns: DataServiceRuntimeEnvironmentResponse

Parameters

Name	Type	Description	Required
data_service_id	string	data service id.	True
body	Environment	default runtime environment for the data service.	True

[Back to top] [Back to API list] [Back to Models]

update_read_connector

update read connector in dataflow

Returns: ReadConnectorResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
read_connector_id	string	The unique identifier of this read connector.	True
body	ReadConnector	Read connector to be created/updated.	True

[Back to top] [Back to API list] [Back to Models]

update_read_connector_paused_state

pause or unpause a read connector

Returns: PausedStateResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True
body	UpdatePausedStateRequest.Options		True
paused	boolean	Set to true to pause, or false(default) to unpause.	False

[Back to top] [Back to API list] [Back to Models]

update_site_connection

update connection at the site level

Returns: UpdateConnectionResponse

Parameters

Name	Type	Description	Required
id_value	string		True
body	Connection		True

[Back to top] [Back to API list] [Back to Models]

update_site_credentials

update site-level credentials

Returns: CredentialsResponse

Parameters

Name	Type	Description	Required
credential_id	string	Credential id.	True
body	Credentials	Credentials.	True

[Back to top] [Back to API list] [Back to Models]

update_spark_cluster_pool

update a spark cluster pool

Returns: SparkClusterPoolResponse

Parameters

Name	Type	Description	Required
uuid	string	Ascend-assigned unique identifier for cluster	True
body	SparkClusterPool		True

[Back to top] [Back to API list] [Back to Models]

update_transform

update transform in dataflow

Returns: TransformResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
transform_id	string	The unique identifier of this transform.	True
body	Transform	Transform details.	True

[Back to top] [Back to API list] [Back to Models]

update_transform_paused_state

pause or unpause a transform

Returns: PausedStateResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True
body	UpdatePausedStateRequest.Options		True
paused	boolean	Set to true to pause, or false(default) to unpause.	False

[Back to top] [Back to API list] [Back to Models]

update_write_connector

update write connector in dataflow

Returns: WriteConnectorResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
write_connector_id	string	The unique identifier of this write connector.	True
body	WriteConnector	Write connector details.	True

[Back to top] [Back to API list] [Back to Models]

update_write_connector_paused_state

pause or unpause a write connector

Returns: PausedStateResponse

Parameters

Name	Type	Description	Required
data_service_id	string	Data service id.	True
dataflow_id	string	Dataflow id.	True
id	string	Component id.	True
body	UpdatePausedStateRequest.Options		True
paused	boolean	Set to true to pause, or false(default) to unpause.	False

[Back to top] [Back to API list] [Back to Models]

Models Documentation

ascend.protos.api.api_pb2.AscendVersionResponse

Api Version response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	AscendVersionResponse.PlatformVersion		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.AscendVersionResponse.AscendVersion

Name	Type	Required
version	string	False
build_hash	string	False
build_time	string	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.AscendVersionResponse.PlatformVersion

Name	Type	Description	Required
api	AscendVersionResponse.AscendVersion		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.Component

A dataflow component.

Name	Type	Description	Required
id	string	The unique identifier of this component.	False
created_at	string	Creation timestamp.	False
creator_UUID	string		False
deleted_at	string		False
description	string	Short description.	False
name	string	Component name.	False
status	string		False
type	string	Legacy type for component.	False
updated_at	string	Last updated timestamp.	False
uuid	string	Component UUID.	False
version	integer		False
inputComponentIDs	string	Input scheduler-assigned component ids.	False
inputs	List<Component.Input>	Input components, populated only for transforms.	False
ComponentID	string	Internal ID assigned by scheduler.	False
organization	DataService	Parent data service.	False
prj_id	string	Dataflow id.	False
project	Dataflow	Parent dataflow.	False
inputType	string	Input component legacy type - "source"/"view"/"sink".	False
inputUUID	string	Input component UUID.	False
open	boolean	Open for sharing with all data services - specific to data feeds.	False
pubToRoles	string	A list of data service roles to allow sharing - specific to data feeds.	False
source	Source	Read connector details, populated if component is a read connector.	False
view	View	Transform details, populated if component is a transform.	False
sink	Sink	Write connector details, populated if component is a write connector.	False
content	List<Component.Input>	Input component details, only populated for groups.	False
schema	Schema	Component schema.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.Component.Input

Name	Type	Description	Required
type	string	Legacy type for input component.	False
uuid	string	Input component UUID.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentErrorsResetRequest.Options

Name	Type	Description	Required
all	boolean		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentErrorsResetResponse

Component errors reset response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	ComponentErrorsResetResponse.Response		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentErrorsResetResponse.Response

Name	Type	Description	Required
uuid	string	Component UUID.	False
status	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentErrorsResponse

Component errors response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	ComponentErrorsResponse.Response	List of partition errors.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentErrorsResponse.Response

Name	Type	Description	Required
errors	Partition.Error.Sequence		False
uuid	string	Component UUID.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentGroup

A component group.

Name	Type	Description	Required
id	string	The unique identifier of this component group.	False
created_at	string	Creation timestamp.	False
creator_UUID	string		False
deleted_at	string		False
description	string	Short description.	False
name	string	Component group name.	False
status	string		False
type	string	Legacy type for group.	False
updated_at	string	Last updated timestamp.	False
uuid	string	Group UUID.	False
version	integer		False
organization	DataService	Parent data service.	False
prj_id	string	Dataflow id.	False
project	Dataflow	Parent dataflow.	False
content	List<ComponentGroup.Input>	List of member components.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentGroup.Input

Name	Type	Description	Required
type	string	Legacy type for constituent component.	False
uuid	string	Constituent component UUID.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentGroupResponse

Component group response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	ComponentGroup	Component group details.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentGroupsResponse

Component group listing response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	List<ComponentGroup>	Component group details.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentLineageResponse

Component lineage response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	ComponentLineageResponse.Response		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentLineageResponse.Node

Name	Type	Description	Required
data_service_id	string	Data service id.	False
data_flow_id	string		False
id	string	Component id.	False
uuid	string	Component UUID.	False
component_id	string		False
component_type	string		False
schema	List		False
expression	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentLineageResponse.Response

Name	Type	Description	Required
component_nodes	List<ComponentLineageResponse.Node>		False
component_edges	List<Lineage.Component.Edge>		False
column_nodes	List<Lineage.Column.Node>		False
column_edges	List<Lineage.Column.Edge>		False
uuid	string	Backend UUID.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentLogsResponse

Name	Type	Description	Required
status	string		False
data	ComponentLogsResponse.Response		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentLogsResponse.Response

Name	Type	Required
result	List<ComponentLogsResponse.Response.Stream>	False
resultType	string	False
stats	object	False
next_page_cursor	int64	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentLogsResponse.Response.Stream

Name	Type	Description	Required
stream	object		False
values	List<List>		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentPartitionsResponse

Component partitions response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	ComponentPartitionsResponse.Response	List of Partition metadata results.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentPartitionsResponse.Response

Name	Type	Description	Required
data	Partition.Metadata.Sequence		False
uuid	string	Component UUID.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentQualityTestResultsResponse

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	ComponentQualityTestResultsResponse.TestResultsResponse		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentQualityTestResultsResponse.TestResultsResponse

Name	Type	Description	Required
test_summaries	List<ComponentQualityTestResultsResponse.TestResultsResponse.TestSummary>		False
test_records	List<ComponentQualityTestResultsResponse.TestResultsResponse.TestRecord>		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentQualityTestResultsResponse.TestResultsResponse.TestRecord

Name	Type	Required
execution_time_in_seconds	number	False
result_count	uint64	False
partition_id	string	False
error	string	False
column_name	string	False
combined_rule	string	False
custom_key	string	False
custom_code	string	False
query	string	False
failure_effect	string	False
result	string	False
job_id	string	False
extra	string	False
created_at	string	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentQualityTestResultsResponse.TestResultsResponse.TestSummary

Name	Type	Required
column_name	string	False
rule	string	False
custom_code	string	False
result	string	False
active_partition_count	uint64	False
test_partition_count	uint64	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentRecordsResponse

Component records response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	ComponentRecordsResponse.Response	Records preview response.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentRecordsResponse.Response

Name	Type	Description	Required
data	Response		False
uuid	string	Component UUID.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentSchemaResponse

Component schema response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	ComponentSchemaResponse.Schema	Schema response.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentSchemaResponse.Schema

Name	Type	Description	Required
schema	string	Comma-separated list of field names.	False
uuid	string	Component UUID.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentsResponse

Component listing response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	List<Component>	List of components.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentStateResponse

Component state response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	ComponentStateResponse.State	Component state details.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentStateResponse.State

Name	Type	Description	Required
state	State		False
uuid	string	Component UUID.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentStatisticsResponse

Component statistics response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	ComponentStatisticsResponse.Statistics	Component statistics collection.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentStatisticsResponse.Statistics

Name	Type	Description	Required
statistics	Statistics.Collection		False
uuid	string	Component UUID.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentWarningsResponse

Component warnings response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	ComponentWarningsResponse.Response	List of partition warnings.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ComponentWarningsResponse.Response

Name	Type	Description	Required
warnings	Partition.Warning.Sequence		False
uuid	string	Component UUID.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ConnectionResponse

Name	Type	Required
request_uri	string	False
response_code	integer	False
success	boolean	False
data	Connection	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ConnectionsResponse

Name	Type	Required
request_uri	string	False
response_code	integer	False
success	boolean	False
data	List<Connection>	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ConnectionTypeResponse

Name	Type	Required
request_uri	string	False
response_code	integer	False
success	boolean	False
data	Connection.Type	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ConnectionTypesResponse

Name	Type	Required
request_uri	string	False
response_code	integer	False
success	boolean	False
data	List<Connection.Type>	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ContainerImageDeleteResponse

Container image deletion response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	ContainerImageDeleteResponse.ContainerImageStatus	ContainerImage deletion status.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ContainerImageDeleteResponse.ContainerImageStatus

Name	Type	Description	Required
label	string		False
status	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ContainerImageResponse

Container image creation response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	Spark.ContainerImage	ContainerImage definition.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ContainerImagesResponse

Container images response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	List<Spark.ContainerImage>	list of ContainerImage definitions.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.CreateConnectionResponse

Name	Type	Required
request_uri	string	False
response_code	integer	False
success	boolean	False
data	Connection	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.Credentials

component credentials

Name	Type	Description	Required
name	string	Credential name that is unique across the Ascend environment.	True
credential_id	string	Credential id.	False
credential_type	string		False
canonical_credential_id	string		False
is_private	boolean		False
owner_orgs	List<Credentials.Org>		False
credential	Credentials		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.Credentials.Org

Name	Type	Description	Required
org_id	string		False
org_name	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.CredentialsResponse

Credentials creation/deletion response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	Credentials		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.DataFeed

A data feed.

Name	Type	Description	Required
id	string	The unique identifier of this data feed.	False
created_at	string	Creation timestamp.	False
creator_UUID	string		False
deleted_at	string		False
description	string	Short description.	False
name	string	Data feed name.	False
status	string		False
type	string	Legacy type for data feed.	False
updated_at	string	Last updated timestamp.	False
uuid	string	Data feed UUID.	False
version	integer		False
ComponentID	string	Internal ID assigned by scheduler.	False
organization	DataService	Parent data service.	False
prj_id	string	Dataflow id.	False
project	Dataflow	Parent dataflow.	False
inputType	string	Input component legacy type - example - "view".	False
inputUUID	string	Input component UUID.	False
inputComponentId	string	Input scheduler-assigned component id.	False
open	boolean	Open for sharing with all data services.	False
pubToRoles	string	A list of data service roles to allow sharing.	False
schema	Schema	Component schema.	False
upstream_status	Status		False
org_id	string	Data service id.	False
public	boolean		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.DataFeedConnector

A data feed connector.

Name	Type	Description	Required
id	string	The unique identifier of this data feed connector.	False
created_at	string	Creation timestamp.	False
creator_UUID	string		False
deleted_at	string		False
description	string	Short description.	False
name	string	Data feed connector name.	False
status	string		False
type	string	Legacy type for data feed connector.	False
updated_at	string	Last updated timestamp.	False
uuid	string	Data feed connector UUID.	False
version	integer		False
ComponentID	string	Internal ID assigned by scheduler.	False
organization	DataService	Parent data service.	False
prj_id	string	Dataflow id.	False
project	Dataflow	Parent dataflow.	False
pubUUID	string	UUID of input data feed.	False
schema	Schema	Component schema.	False
upstream_status	Status		False
stages	List<Stage>		False
default_stage	Stage		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.DataFeedConnectorResponse

Data feed connector response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	DataFeedConnector	Data feed connector details.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.DataFeedConnectorsResponse

Data feed connector listing response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	List<DataFeedConnector>	List of data feed connectors.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.DataFeedResponse

Data feed response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	DataFeed	Data feed details.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.DataFeedsResponse

Data feed listing response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	List<DataFeed>	List of data feeds.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.Dataflow

A dataflow.

Name	Type	Description	Required
id	string	The unique identifier of this dataflow.	False
created_at	string	Creation timestamp.	False
creator_UUID	string		False
deleted_at	string		False
description	string	Short description.	False
name	string	Data flow name.	False
org_id	string	Data service id.	False
organization	DataService	Parent data service.	False
status	string		False
type	string	Legacy type.	False
updated_at	string	Last updated timestamp.	False
uuid	string	Dataflow UUID.	False
version	integer		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.DataflowDataPlaneConfigResponse

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	DataPlaneConfig	dataflow data plane config.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.DataflowErrorsResetRequest.Options

Name	Type	Description	Required
all	boolean		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.DataflowErrorsResetResponse

Data flow errors reset response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	List<DataflowErrorsResetResponse.Response>		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.DataflowErrorsResetResponse.Response

Name	Type	Description	Required
uuid	string	Component UUID.	False
error	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.DataflowResponse

Dataflow response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	Dataflow	Dataflow details.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.DataflowsResponse

Dataflow listing response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	List<Dataflow>	List of dataflows.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.DataService

A data service.

Name	Type	Description	Required
id	string	The unique identifier of this data service.	True
created_at	string	Creation timestamp.	False
creator_UUID	string		False
deleted_at	string		False
description	string	Short description.	False
name	string	Data service name.	False
status	string		False
type	string	Legacy type.	False
updated_at	string	Last updated timestamp.	False
uuid	string	Data service UUID.	False
version	integer		False
data_service_type	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.DataServiceDataPlaneConfigResponse

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	DataPlaneConfig	data service data plane config.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.DataServiceResponse

Data service response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	DataService	Data service.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.DataServiceRole

Data service role.

Name	Type	Description	Required
id	string	The unique identifier of this role.	False
uuid	string	Role UUID.	False
name	string	Role name.	False
org_id	string	Data service id.	False
org_name	string	Data service name.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.DataServiceRolesResponse

Data service roles response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	List<DataServiceRole>	List of data service roles.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.DataServiceRuntimeEnvironmentResponse

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	Environment	data service runtime environment.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.DataServicesResponse

Data services listing response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	List<DataService>	List of data services.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.Delete

Details in delete response.

Name	Type	Description	Required
uuid	string	Deleted resource UUID.	False
affected	int64		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.DeleteCredentialsResponse

Data service credentials deletion response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	DeleteCredentialsResponse.CredentialsStatus		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.DeleteCredentialsResponse.CredentialsStatus

Name	Type	Description	Required
credential_id	string		False
status	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.DeleteResponse

Data service deletion response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	Delete	deleted resource.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.EnvConfigResponse

Environment config response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	EnvConfig	data service data plane config.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ListCredentialsResponse

Data service credentials listing response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	List<Credentials>	List of credentials.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.PausedStateResponse

Read connector refresh response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	PausedStateResponse.Response		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.PausedStateResponse.Response

Name	Type	Description	Required
uuid	string		False
status	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.PreviewConnectionResponse

Name	Type	Required
request_uri	string	False
response_code	integer	False
success	boolean	False
data	Response.RecordsResponse	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ReadConnector

A read connector.

Name	Type	Description	Required
id	string	The unique identifier of this read connector.	False
created_at	string	Creation timestamp.	False
creator_UUID	string		False
deleted_at	string		False
description	string	Short description.	False
name	string	Read connector name.	False
status	string		False
type	string	Legacy type for component.	False
updated_at	string	Last updated timestamp.	False
uuid	string	Read connector UUID.	False
version	integer		False
ComponentID	string	Internal ID assigned by scheduler.	False
organization	DataService	Parent data service.	False
prj_id	string	Dataflow id.	False
project	Dataflow	Parent dataflow.	False
source	Source	Read connector details.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ReadConnectorRefreshResponse

Read connector refresh response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	ReadConnectorRefreshResponse.Response		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ReadConnectorRefreshResponse.Response

Name	Type	Description	Required
uuid	string	Read connector UUID.	False
status	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ReadConnectorResponse

Read connector response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	ReadConnector	Read connector.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ReadConnectorsResponse

Read connector listing response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	List<ReadConnector>	List of read connectors.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.ShareConnectionResponse

Name	Type	Required
request_uri	string	False
response_code	integer	False
success	boolean	False
data	string	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.SparkClusterPoolResponse

Spark cluster pool creation response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	SparkClusterPool		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.SparkClusterPoolsResponse

Spark cluster pools response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	List<SparkClusterPool>	list of Spark cluster pools.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.SparkClusterPoolStatusResponse

Spark cluster pool status response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	SparkClusterPool.Status.Response	Spark cluster pool status.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.Status

Name	Type	Description	Required
imputed_priority	ImputedPriority	Imputed Processing Priority for component.	False
stages	List<Stage>	Stages for component.	False
default_stage	Stage	Default stage of component.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.Transform

A transform.

Name	Type	Description	Required
id	string	The unique identifier of this transform.	False
created_at	string	Creation timestamp.	False
creator_UUID	string		False
deleted_at	string		False
description	string	Short description.	False
name	string	Transform name.	False
status	string		False
type	string	Legacy type for transform.	False
updated_at	string	Last updated timestamp.	False
uuid	string	Transform UUID.	False
version	integer		False
ComponentID	string	Internal ID assigned by scheduler.	False
organization	DataService	Parent data service.	False
prj_id	string	Dataflow id.	False
project	Dataflow	Parent dataflow.	False
inputComponentIDs	string	Input scheduler-assigned component ids.	False
inputs	List<Transform.Input>	List of input components.	False
view	View	Transform details.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.Transform.Input

Name	Type	Description	Required
type	string	Legacy type for input component.	False
uuid	string	Input component UUID.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.TransformResponse

Transform response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	Transform	Transform details.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.TransformsResponse

Transform listing request.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	List<Transform>	List of transforms.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.UpdateConnectionResponse

Name	Type	Required
request_uri	string	False
response_code	integer	False
success	boolean	False
data	Connection	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.UpdatePausedStateRequest.Options

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.WriteConnector

A write connector.

Name	Type	Description	Required
id	string	The unique identifier of this write connector.	False
created_at	string	Creation timestamp.	False
creator_UUID	string		False
deleted_at	string		False
description	string	Short description.	False
name	string	Write connector name.	False
status	string		False
type	string	Legacy type for write connector.	False
updated_at	string	Last updated timestamp.	False
uuid	string	Write connector UUID.	False
version	integer		False
ComponentID	string	Internal ID assigned by scheduler.	False
organization	DataService	Parent data service.	False
prj_id	string	Dataflow id.	False
project	Dataflow	Parent dataflow.	False
inputComponentIDs	string	Input scheduler-assigned component ids.	False
inputType	string	Input component legacy type - "source"/"view".	False
inputUUID	string	Input component UUID.	False
sink	Sink	Write connector details.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.WriteConnectorResponse

Write connector response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	WriteConnector	Write connector details.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.api.api_pb2.WriteConnectorsResponse

Write connector listing response.

Name	Type	Description	Required
request_uri	string		False
response_code	integer	http response code.	False
success	boolean	success defined by a 2xx http response code.	False
data	List<WriteConnector>	List of write connectors.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.ascend.ascend_pb2.Struct

Direct copy of google/protobuf/struct.proto with added types. We
need to extend Value message to include other numeric types.

Name	Type	Description	Required
fields	object	Unordered map of dynamically typed values.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.ascend.ascend_pb2.Union

Name	Type	Description	Required
tag	string		False
value	Value		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.ascend.ascend_pb2.Value

Value represents a dynamically typed value which can be either
null, a number, a string, a boolean, a recursive struct value, or a
list of values. A producer of value is expected to set one of that
variants, absence of any variant indicates an error.

The JSON representation for Value is JSON value.

Name	Type	Description	Required
null_value	string	Represents a null value.	False
number_value	number	Represents a double value.	False
string_value	string	Represents a string value.	False
bool_value	boolean	Represents a boolean value.	False
struct_value	Struct	Represents a structured value.	False
list_value	Values	Represents a repeated `Value`.	False
byte_value	integer		False
short_value	integer		False
int_value	integer		False
long_value	int64		False
timestamp_value	date-time	Represents a Timestamp value.	False
date_value	date-time		False
date_time_value	date-time		False
decimal_value	string		False
binary_value	byte		False
union_value	Union	Represents a tagged union value.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.ascend.ascend_pb2.Values

Name	Type	Description	Required
values	List<Value>	Repeated field of dynamically typed values.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.ApiDescriptor

Name	Type	Required
id	string	False
dataflow_id	string	False
data_service_id	string	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.Descriptor

Name	Type	Required
id	Id	False
type	Type	False
api_info	ApiDescriptor	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.Id

Name	Type	Description	Required
value	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.ImputedPriority

Name	Type	Description	Required
weight	number		False
paused_by	Descriptor		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.Lineage.Column.Edge

Name	Type	Required
input	integer	False
output_component_expression_selection	Lineage.Selection	False
expression	string	False
output_column	integer	False
output_component	integer	False
project	Lineage.Column.Edge.Project	False
aggregate	Lineage.Column.Edge.Aggregate	False
filter	Lineage.Column.Edge.Filter	False
order	Lineage.Column.Edge.Order	False
sink	Lineage.Column.Edge.Sink	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.Lineage.Column.Edge.Aggregate

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.Lineage.Column.Edge.Filter

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.Lineage.Column.Edge.Order

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.Lineage.Column.Edge.Project

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.Lineage.Column.Edge.Sink

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.Lineage.Column.Node

Name	Type	Required
name	string	False
expression	string	False
component_node_index	integer	False
component_expression_selection	Lineage.Selection	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.Lineage.Component.Edge

Name	Type	Required
input	integer	False
output	integer	False
output_expression_selection	Lineage.Selection	False
expression	string	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.Lineage.Selection

Name	Type	Description	Required
start	Lineage.Selection.Position		False
end	Lineage.Selection.Position		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.Lineage.Selection.Position

Name	Type	Required
index	integer	False
line	integer	False
column	integer	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.Priority

Processing Priority. Higher weight will be processed first.
If there is no weight, it will be processed as if its weight were 0.
Negative weights will be processed last.

Name	Type	Description	Required
weight	number		False
paused	boolean		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.Sink

Sink (Write Connector) component details.

Name	Type	Description	Required
input	Id	Id of the input component.	False
container	Container	Sink Container.	False
assigned_priority	Priority	Assigned Processing Priority for component.	False
status	Sink.Status	Sink Status. Read-only.	False
compute_configurations	List<StageComputeConfiguration>		False
bytes	Sink.ToBytes	Byte ouptut details. Required if sink has byte container.	False
records	Sink.ToRecords	Record output details. Required if sink has record container.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.Sink.Status

Sink status.

Name	Type	Description	Required
imputed_priority	ImputedPriority	Imputed Processing Priority for component.	False
stages	List<Stage>	Stages for component.	False
default_stage	Stage	Default stage of component.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.Sink.ToBytes

Byte output details.

Name	Type	Description	Required
formatter	Operator	Operator to transform record input data to byte output data.	False
content_encoding	ContentEncoding	Content encoding for output data.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.Sink.ToRecords

Record output details.

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.Source

Source (Read Connector) component details.

Name	Type	Description	Required
pattern	Pattern	Source list pattern.	False
container	Container	Source container.	False
updatePeriodical	Periodical	Source Refresh Period.	False
last_manual_refresh_time	date-time	Last Manual refresh for source ("Refresh Now").	False
assigned_priority	Priority	Processing Priority of Source.	False
status	Source.Status	Source status. Read-only.	False
aggregation_limit	int64	Dyanamic source aggregation limit. Dynamic Source aggregation will be disabled if this is field is absent.	False
compute_configurations	List<StageComputeConfiguration>		False
non_materialized	boolean	if set to true, do not materialize source data in the internal container.	False
bytes	Source.FromBytes	Populated if input data is bytes.	False
records	Source.FromRecords	Populated if input data is records.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.Source.FromBytes

Byte data input details.

Name	Type	Description	Required
parser	Operator	Operator to transform byte input data to records.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.Source.FromRecords

Record data input details.

Name	Type	Description	Required
schema	Map	Schema of record data.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.Source.Status

Source status.

Name	Type	Description	Required
imputed_priority	ImputedPriority	Imputed Processing Priority for component.	False
schema	Schema	Component schema.	False
stages	List<Stage>	Stages for component.	False
asr_status	Source.Status.AsrStatus	Dynamic source refresh status for source list.	False
earliest_list_partition_refresh_time	date-time	Oldest still-valid source refresh time.	False
most_recent_list_partition_refresh_time	date-time	Most recent source refresh time.	False
default_stage	Stage	Default stage of component.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.Source.Status.AsrStatus

Dynamic source refresh status for source list.

Name	Type	Description	Required
refresh_suspended_until	date-time	Time for which re-listing is suspended due to unchanging results.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.State

The state of a component.

Name	Type	Description	Required
composite_state	State	Representative state, composited between the different stages of the component.	False
stage_states	List<StageState>	States for individual stages of the component.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.Type

Name	Type	Required
source	Type.Source	False
view	Type.View	False
sink	Type.Sink	False
pub	Type.Pub	False
sub	Type.Sub	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.Type.Pub

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.Type.Sink

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.Type.Source

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.Type.Sub

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.Type.View

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.View

View (Transform) component details.

Name	Type	Description	Required
input	List<Id>	List of input component Ids. Required to be non-empty.	False
operator	Operator	Operator to perform the transformation.	False
assigned_priority	Priority	Assigned Processing Priority for component.	False
status	View.Status	View Status. Read-only.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.component.component_pb2.View.Status

View Status.

Name	Type	Description	Required
imputed_priority	ImputedPriority	Imputed Processing Priority for component.	False
schema	Schema	Component schema.	False
stages	List<Stage>	Stages for component.	False
default_stage	Stage	Default stage of component.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.connection.connection_pb2.AccessMode

Name	Type	Required
read_only	AccessMode.ReadOnly	False
read_write	AccessMode.ReadWrite	False
write_only	AccessMode.WriteOnly	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.connection.connection_pb2.AccessMode.ReadOnly

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.connection.connection_pb2.AccessMode.ReadWrite

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.connection.connection_pb2.AccessMode.WriteOnly

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.connection.connection_pb2.Credentials

Name	Type	Description	Required
type_id	Type.Id		False
details	object		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.connection.connection_pb2.Id

Name	Type	Description	Required
value	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.connection.connection_pb2.Type.Configuration.Field

Name	Type	Required
name	string	False
label	string	False
tooltip_text	string	False
default_value	Value	False
min_value	Value	False
max_value	Value	False
required	boolean	False
avoid_checksum	boolean	False
runs_user_code	boolean	False
access_mode	AccessMode	False
boolean	Type.Configuration.Field.Boolean	False
date	Type.Configuration.Field.Date	False
double	Type.Configuration.Field.Double	False
float	Type.Configuration.Field.Float	False
int	Type.Configuration.Field.Int	False
long	Type.Configuration.Field.Long	False
string	Type.Configuration.Field.String	False
struct	Type.Configuration.Field.Struct	False
timestamp	Type.Configuration.Field.Timestamp	False
union	Type.Configuration.Field.Union	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.connection.connection_pb2.Type.Configuration.Field.Boolean

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.connection.connection_pb2.Type.Configuration.Field.Date

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.connection.connection_pb2.Type.Configuration.Field.Double

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.connection.connection_pb2.Type.Configuration.Field.Float

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.connection.connection_pb2.Type.Configuration.Field.Int

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.connection.connection_pb2.Type.Configuration.Field.Long

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.connection.connection_pb2.Type.Configuration.Field.String

Name	Type	Required
multiline	boolean	False
sensitive	boolean	False
code_editor	Type.Configuration.Field.String.CodeEditor	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.connection.connection_pb2.Type.Configuration.Field.String.CodeEditor

Name	Type	Description	Required
language	Type.Configuration.Field.String.CodeEditor.Language		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.connection.connection_pb2.Type.Configuration.Field.String.CodeEditor.Language

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.connection.connection_pb2.Type.Configuration.Field.Struct

Name	Type	Description	Required
fields	List<Type.Configuration.Field>		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.connection.connection_pb2.Type.Configuration.Field.Timestamp

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.connection.connection_pb2.Type.Configuration.Field.Union

Union produces an protos.ascend.Union value, with tag equals to selected field name.
If a selected field is of Struct type, a UI should render a sub-form to collect details.
Otherwise, its default value is used as the specified value.

Name	Type	Description	Required
fields	List<Type.Configuration.Field>		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.connection.connection_pb2.Type.Configuration.Shape

Name	Type	Description	Required
fields	List<Type.Configuration.Field>		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.connection.connection_pb2.Type.Icon

Name	Type	Description	Required
url	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.connection.connection_pb2.Type.Id

Name	Type	Description	Required
value	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.connection.connection_pb2.Type.Status

Name	Type	Required
connection_configuration_shape	Type.Configuration.Shape	False
asset_configuration_shape	Type.Configuration.Shape	False
credentials_configuration_shape	Type.Configuration.Shape	False
icon	Type.Icon	False
require_credentials	boolean	False
category_id	string	False
access_mode	AccessMode	False
premium	boolean	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.content_encoding.content_encoding_pb2.Compress

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.content_encoding.content_encoding_pb2.ContentEncoding

Name	Type	Required
identity	Identity	False
compress	Compress	False
deflate	Deflate	False
gzip	Gzip	False
lzo	Lzo	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.content_encoding.content_encoding_pb2.Deflate

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.content_encoding.content_encoding_pb2.Gzip

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.content_encoding.content_encoding_pb2.Identity

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.content_encoding.content_encoding_pb2.Lzo

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.core.core_pb2.CronPeriodical

Name	Type	Description	Required
expression	List		False
zone_id	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.core.core_pb2.ListValue

Name	Type	Description	Required
values	List<Value>	Repeated field of dynamically typed values.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.core.core_pb2.LogRequest

Name	Type	Description	Required
label	string	label identifying logs.	False
range_start	int64	start of log query: UTC unix timestamp in nanoseconds.	False
range_end	int64	end of log query: UTC unix timestamp in nanoseconds.	False
jwt	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.core.core_pb2.Periodical

Name	Type	Required
period	string	False
offset	string	False
cron	CronPeriodical	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.core.core_pb2.Statistics

In the scheduler DB. The extra oneofs are so we can differentiate
default values from real values.

Name	Type	Required
cardinality	uint64	False
sum	Value	False
distinct_cardinality	uint64	False
approximate_distinct_cardinality	uint64	False
distinct_values	ListValue	False
distinct_values_available_for_all_non_empty_leaves	boolean	False
schema	Schema	False
minimum	Value	False
maximum	Value	False
null_count	uint64	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.core.core_pb2.Statistics.Collection

Name	Type	Description	Required
dimensions	object		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.core.core_pb2.Struct

Direct copy of google/protobuf/struct.proto with added types. We
need to extend Value message to include other numeric types.

Name	Type	Description	Required
fields	object	Unordered map of dynamically typed values.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.core.core_pb2.Union

Name	Type	Description	Required
tag	string		False
value	Value		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.core.core_pb2.Value

The JSON representation for Value is JSON value.

Name	Type	Description	Required
null_value	string	Represents a null value.	False
number_value	number	Represents a double value.	False
string_value	string	Represents a string value.	False
bool_value	boolean	Represents a boolean value.	False
struct_value	Struct	Represents a structured value.	False
list_value	ListValue	Represents a repeated `Value`.	False
byte_value	integer		False
short_value	integer		False
int_value	integer		False
long_value	int64		False
timestamp_value	date-time	Represents a Timestamp value.	False
date_value	date-time		False
date_time_value	date-time		False
decimal_value	string		False
binary_value	byte		False
union_value	Union	Represents a tagged union value.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.environment.environment_pb2.DataPlaneConfig

Name	Type	Description	Required
snowflake	DataPlaneConfig.Snowflake		False
databricks	DataPlaneConfig.Databricks		False
spark	DataPlaneConfig.Spark		False
bigquery	DataPlaneConfig.BigQuery		False
spark_cluster_pool_id	string		False
spark_cluster_pool_usage_overrides	map<string, string>	Map of usage category to cluster pool id	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.environment.environment_pb2.DataPlaneConfig.BigQuery

Name	Type	Required
connection_id	string	False
dataset_template	string	False
table_template	string	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.environment.environment_pb2.DataPlaneConfig.Databricks

Name	Type	Required
connection_id	string	False
endpoint_id	string	False
cluster_id	string	False
database_template	string	False
table_template	string	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.environment.environment_pb2.DataPlaneConfig.Snowflake

Name	Type	Description	Required
warehouse	string		False
connection_id	string		False
database_template	string		False
schema_template	string		False
cleanup_strategy	string		False
table_template	string		False
warehouse_usage_overrides	map<string, string>	Map of usage category to warehouse name	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.environment.environment_pb2.DataPlaneConfig.Spark

Name	Type	Description	Required
connection_id	string		False
root_path	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.environment.environment_pb2.EnvConfig

Name	Type	Description	Required
key	string		False
value	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.environment.environment_pb2.Spark.ContainerImage

Runtime container image.

Name	Type	Description	Required
label	string	a unique reference to the image.	False
name	string	fully qualified image name including registry name, repository, and tag.	False
runtime	string	spark runtime - has the format "scala:<scala_ver>;spark:<spark_ver>", example - scala:2.12;spark:3.2.0.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.environment.environment_pb2.SparkClusterPool

Name	Type	Description	Required
id	string		False
uuid	string		False
container_image	string		False
spark_runtime	string		False
driver_cpus	integer	Size of driver in vcpus - size of memory is determined by cpu:mem ratio of the node type used in the cluster.	False
executor_cpus	integer		False
min_executors	integer		False
max_executors	integer		False
cluster_auto_termination_mins	integer		False
min_clusters_in_pool	integer		False
max_clusters_in_pool	integer		False
is_default	boolean		False
is_original_config	boolean		False
status	List<SparkClusterStatus>		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.environment.environment_pb2.SparkClusterStatus

Name	Type	Description	Required
cluster_id	string		False
state	SparkClusterStatus.State		False
task_slots_used	integer		False
task_slots_total	integer		False
num_executors	integer	number of active executors.	False
assigned_tasks	List<SparkClusterStatus.TaskDetails>		False
events	List	a list of JSON-serialized k8s events related to the cluster.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.environment.environment_pb2.SparkClusterStatus.State

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.environment.environment_pb2.SparkClusterStatus.TaskDetails

Name	Type	Required
task_signature	string	False
data_service_id	string	False
dataflow_id	string	False
component_id	string	False
task_slots_used	integer	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.Partition.Error

Name	Type	Description	Required
fault	Fault		False
recorded_at	date-time	Last recorded error timestamp.	False
failedAttempts	int64	Total number of times this partition has failed.	False
log_request	LogRequest	Parameters to request logs.	False
partition_request_token	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.Partition.Error.Sequence

Name	Type	Description	Required
error	List<Partition.Error>		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.Partition.Metadata

Name	Type	Description	Required
state	Partition.State	State for partition.	False
statistics	Statistics.Collection	Statistics for partition.	False
errors	List<Partition.Error>	Errors for partition.	False
request_token	string	Unique token to specify partition in requests.	False
failure_statistics	Statistics.Collection	Statistics for failures associated with partition.	False
label	string	Unique label to identify partition.	False
log_request	LogRequest	Parameters to request logs for partition.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.Partition.Metadata.Sequence

Name	Type	Description	Required
metadata	List<Partition.Metadata>		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.Partition.State

State for Partition.

Name	Type	Description	Required
total	int64	Total number of partitions, empty if unknown.	False
up_to_date	int64	Number of up to date partitions.	False
running	int64	Number of running partitions.	False
retrying	int64	Number of retrying partitions.	False
errors	List<Partition.Error>		False
warnings	List<Fault>		False
num_warnings	int64	Number of warnings.	False
eligible_for_retry	int64	Number of partitions which have failed and can be retried now.	False
ineligible_for_retry	int64	Number of partitions which have failed and can be retried later.	False
never_eligible_for_retry	int64	Number of partitions which have failed and exhausted all retries.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.Partition.Warning

Name	Type	Description	Required
fault	Fault		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.Partition.Warning.Sequence

Name	Type	Description	Required
warning	List<Partition.Warning>		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.Stage

Name	Type	Required
analyze	Stage.Analyze	False
latest	Stage.Latest	False
list	Stage.List	False
load	Stage.Load	False
parse	Stage.Parse	False
query	Stage.Query	False
read	Stage.Read	False
register	Stage.Register	False
reshape	Stage.Reshape	False
staging_list	Stage.StagingList	False
staging_sweep	Stage.StagingSweep	False
staging_write	Stage.StagingWrite	False
sweep	Stage.Sweep	False
transform	Stage.Transform	False
union	Stage.Union	False
write	Stage.Write	False
write_manifest	Stage.WriteManifest	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.Stage.Analyze

Name	Type	Description	Required
index	integer		False
dimension	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.Stage.Latest

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.Stage.List

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.Stage.Load

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.Stage.Parse

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.Stage.Query

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.Stage.Read

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.Stage.Register

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.Stage.Reshape

Name	Type	Description	Required
index	integer		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.Stage.StagingList

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.Stage.StagingSweep

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.Stage.StagingWrite

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.Stage.Sweep

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.Stage.Transform

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.Stage.Union

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.Stage.Write

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.Stage.WriteManifest

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.StageComputeConfiguration

Name	Type	Description	Required
stage	Stage		False
configuration	ComputeConfiguration		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.StageState

Message associating a specific stage with its state.

Name	Type	Description	Required
stage	Stage		False
state	State		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.State

Expression state.

Name	Type	Description	Required
partition_state	Partition.State	Aggregated partition states of expression.	False
text	string	State label.	False
errors	List<Fault>	Errors for state. Only populated in webhooks, when in error state.	False
maybe_committed_partition_count	int64	If results are available, the number of comitted partitions.	False
up_to_date	State.UpToDate	Populated if state is Up To Date. This means that the component has completed processing with respect to all updates to itself, and its inputs.	False
running	State.Running	Populated if state is Running. This means that there are currently tasks running for the component that will contribute to making the component Up To Date.	False
out_of_date	State.OutOfDate	Populated if state is out of date. This means that the component is not Up To Date or Running, wrapping more specific details inside the OutOfDate message.	False
error	State.Error	Populated if the state is in Error. This means that the component has errors which have exhausted all retries.	False
pending	State.Pending		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.State.Error

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.State.OutOfDate

Name	Type	Description	Required
blocked	State.OutOfDate.Blocked	Populated if expression is blocked. This means there is an upstream expression with an error preventing processing of this expression.	False
pending	State.OutOfDate.Pending	Populated if expression is pending on input. This means that there is an upstream expression processing data updates, but there exist results.	False
ready	State.OutOfDate.Ready	Populated if expression is ready to Run. This means that all of its inputs are up to date, however no tasks are currently running.	False
waiting	State.OutOfDate.Waiting	Populated if expression is Waiting. This means that it is waiting for upstream or schema inference processing to finish, and no previous results are available.	False
waiting_for_resources	State.OutOfDate.WaitingForResources	Populated if expression is Waiting For Resources. This means the expression is ready to run but there are currently not enough resources available to run jobs for it.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.State.OutOfDate.Blocked

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.State.OutOfDate.Pending

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.State.OutOfDate.Ready

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.State.OutOfDate.Waiting

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.State.OutOfDate.WaitingForResources

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.State.Pending

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.State.Running

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.expression.expression_pb2.State.UpToDate

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Aws.Credentials

Name	Type	Required
id	string	False
secret	string	False
k8s_service_account	Aws.Credentials.AuthMethod.K8sServiceAccount	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Aws.Credentials.AuthMethod.K8sServiceAccount

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Aws.Redshift.Credentials

Name	Type	Description	Required
username	string		False
password	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Aws.Redshift.Database

Name	Type	Required
credentials	Aws.Redshift.Credentials	False
jdbc_url	string	False
default_to_ssl	boolean	False
credential_id	Credentials.Id	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Aws.Redshift.Table

Name	Type	Description	Required
database	Aws.Redshift.Database		False
name	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Aws.S3.Bucket

Name	Type	Required
credentials	Aws.Credentials	False
name	string	False
region	string	False
credential_id	Credentials.Id	False
sse_kms_arn	string	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Aws.S3.Object

Name	Type	Description	Required
bucket	Aws.S3.Bucket		False
name	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Azure.Abs.Blob

Name	Type	Description	Required
container	Azure.Abs.Container		False
name	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Azure.Abs.Container

Name	Type	Description	Required
account	Azure.Account		False
name	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Azure.Account

Name	Type	Required
credentials	Azure.Credentials	False
name	string	False
credential_id	Credentials.Id	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Azure.Credentials

Name	Type	Required
shared_key	Azure.Credentials.SharedKey	False
service_principal	Azure.Credentials.ServicePrincipal	False
service_principal_json	Azure.Credentials.ServicePrincipalJson	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Azure.Credentials.ServicePrincipal

Name	Type	Required
client_id	string	False
client_secret	string	False
tenant	string	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Azure.Credentials.ServicePrincipalJson

Name	Type	Description	Required
json_key	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Azure.Credentials.SharedKey

Name	Type	Description	Required
key	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Code

Name	Type	Required
language	Code.Language	False
source	Code.Source	False
environment	Environment	False
additional_source	Code.Source	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Code.Source

Name	Type	Required
inline	string	False
object	Code.Source.Object	False
binary	byte	False
built_in		False
override_fingerprint	string	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Code.Source.Object

Name	Type	Description	Required
object	Object		False
version_sha	byte		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Connection.Asset

Name	Type	Description	Required
connection	Id		False
details	object		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Connection.Object

Name	Type	Description	Required
asset	Connection.Asset		False
metadata	Struct		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Credentials.Id

Name	Type	Description	Required
value	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Executable

Name	Type	Description	Required
code	Code		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.File.Object

Name	Type	Description	Required
path	File.Path		False
name	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.File.Path

Name	Type	Description	Required
prefix	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Function.Credentials

Name	Type	Description	Required
secret	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Function.CredentialsConfiguration

Name	Type	Description	Required
id	Credentials.Id		False
credentials	Function.Credentials		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Function.Object

Name	Type	Description	Required
store	Function.Store		False
metadata	Struct		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Function.Store

Name	Type	Description	Required
executable	Executable		False
credentials_configuration	Function.CredentialsConfiguration		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Gcp.BigQuery.Dataset

Name	Type	Description	Required
project	Gcp.Project		False
name	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Gcp.BigQuery.Table

Name	Type	Description	Required
dataset	Gcp.BigQuery.Dataset		False
name	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Gcp.Credentials

Name	Type	Description	Required
json_key	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Gcp.Gcs.Bucket

Name	Type	Required
credentials	Gcp.Credentials	False
name	string	False
credential_id	Credentials.Id	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Gcp.Gcs.Object

Name	Type	Description	Required
bucket	Gcp.Gcs.Bucket		False
name	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Gcp.Project

Name	Type	Required
credentials	Gcp.Credentials	False
name	string	False
credential_id	Credentials.Id	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.MsSqlServer.Credentials

Name	Type	Description	Required
sql_authentication	MsSqlServer.Credentials.SqlAuthentication		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.MsSqlServer.Credentials.SqlAuthentication

Name	Type	Description	Required
user	string		False
password	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.MsSqlServer.Database

Name	Type	Description	Required
server	MsSqlServer.Server		False
name	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.MsSqlServer.Server

Name	Type	Required
credential_id	Credentials.Id	False
credentials	MsSqlServer.Credentials	False
name	string	False
port	integer	False
use_encryption	boolean	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.MsSqlServer.Table

Name	Type	Description	Required
database	MsSqlServer.Database		False
name	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Mysql.Credentials

Name	Type	Required
username	string	False
password	string	False
certificate	Mysql.TlsCertificate	False
auth_method	Mysql.Credentials.AuthMethod	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Mysql.Credentials.AuthMethod

Name	Type	Description	Required
aws_iam	Mysql.Credentials.AuthMethod.AwsIam		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Mysql.Credentials.AuthMethod.AwsIam

Name	Type	Description	Required
region	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Mysql.Database

Name	Type	Description	Required
server	Mysql.Server		False
name	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Mysql.Partition

Name	Type	Description	Required
table	Mysql.Table		False
name	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Mysql.Server

Name	Type	Required
credentials	Mysql.Credentials	False
host	string	False
port	integer	False
credential_id	Credentials.Id	False
disable_tls	boolean	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Mysql.Table

Name	Type	Description	Required
database	Mysql.Database		False
name	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Mysql.TlsCertificate

Name	Type	Required
server_ca	string	False
client_cert	string	False
client_key	string	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Object

Name	Type	Required
redshift	Aws.Redshift.Table	False
s3	Aws.S3.Object	False
abs	Azure.Abs.Blob	False
connection	Connection.Object	False
file	File.Object	False
function	Function.Object	False
big_query	Gcp.BigQuery.Table	False
gcs	Gcp.Gcs.Object	False
ms_sql_server	MsSqlServer.Table	False
mysql_partition	Mysql.Partition	False
mysql	Mysql.Table	False
snowflake	Snowflake.Table	False
spark	Spark.Table	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Snowflake.Credentials

Name	Type	Description	Required
username	string		False
password	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Snowflake.Database

Name	Type	Required
credential_id	Credentials.Id	False
credentials	Snowflake.Credentials	False
account	string	False
warehouse	string	False
database	string	False
snowflake_schema	string	False
role	string	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Snowflake.Table

Name	Type	Description	Required
database	Snowflake.Database		False
name	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Spark.Store

Name	Type	Required
s3	Aws.S3.Bucket	False
gcs	Gcp.Gcs.Bucket	False
abs	Azure.Abs.Container	False
file	File.Path	False
record_connection	Connection.Asset	False
object_suffix	string	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.external.external_pb2.Spark.Table

Name	Type	Required
store	Spark.Store	False
object_prefix	string	False
metadata	Struct	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.AwaitingService

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.AwsBadCredentials

Name	Type	Description	Required
aws	Aws.S3.Location		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.AwsError

Name	Type	Description	Required
aws	Aws.S3.Location		False
user_friendly_message	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.Backtrace

Name	Type	Description	Required
stack_frame	List		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.BadLocationTemplate

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.BadSql

Name	Type	Required
sql	string	False
field_not_found	BadSql.FieldNotFound	False
parse_error	BadSql.ParseError	False
bq_invalid_query	BqInvalidQuery	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.BadSql.FieldNotFound

Name	Type	Description	Required
field	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.BadSql.ParseError

Name	Type	Description	Required
mark	BadSql.ParseError.Mark		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.BadSql.ParseError.Mark

Name	Type	Required
lineno	int64	False
colno	int64	False
line	string	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.BqAccessError

Name	Type	Description	Required
message	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.BqInvalidQuery

Name	Type	Description	Required
project	string	TODO Move under Badql, will drop after all code deployed.	False
dataset	string		False
sql	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.BqLoadAvroEof

Name	Type	Description	Required
message	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.CommandRejected

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.ConnectionFailed

Name	Type	Description	Required
error_message	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.CredentialsMismatch

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.DataLimitExceeded

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.ExternalServiceUnavailable

Name	Type	Required
s3	Aws.S3	False
bigquery	Gcp.BigQuery	False
gcs	Gcp.Gcs	False
mysql	Mysql	False
redshift	Aws.Redshift	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.Fault

Name	Type	Required
description	string	False
backtrace	Backtrace	False
cause	Fault	False
timestamp	date-time	False
awaiting_service	AwaitingService	False
aws_bad_credentials	AwsBadCredentials	False
aws_error	AwsError	False
bad_location_template	BadLocationTemplate	False
bad_sql	BadSql	False
bqAccessError	BqAccessError	False
bq_invalid_query	BqInvalidQuery	False
bqLoadAvroEof	BqLoadAvroEof	False
command_rejected	CommandRejected	False
connection_failed	ConnectionFailed	False
credentials_mismatch	CredentialsMismatch	False
data_limit_exceeded	DataLimitExceeded	False
external_service_unavailable	ExternalServiceUnavailable	False
feature_unavailable	FeatureUnavailable	False
file_not_found	FileNotFound	False
fragment_not_found	FragmentNotFound	False
function_error	FunctionError	False
grpc_message_too_large	GrpcMessageTooLarge	False
illegal_argument	IllegalArgument	False
image_pull_failed	ImagePullFailed	False
insufficient_resources	InsufficientResources	False
internal_error	InternalError	False
internal_service_unavailable	InternalServiceUnavailable	False
invalid_config	InvalidConfig	False
invalid_credentials_on_identity_assignment	InvalidCredentialsOnIdentityAssignment	False
invalid_schema	InvalidSchema	False
list_content_limit_exceeded	ListContentLimitExceeded	False
mysql_bad_credentials	MysqlBadCredentials	False
mysql_db_does_not_exists	MysqlDbDoesNotExist	False
mysql_error	MysqlError	False
no_such_component	NoSuchComponent	False
no_such_task	NoSuchTask	False
object_not_found	ObjectNotFound	False
schema_inference_error	SchemaInferenceError	False
task_canceled	TaskCanceled	False
task_not_found	TaskNotFound	False
task_rejected	TaskRejected	False
too_many_bad_records	TooManyBadRecords	False
udp_error	UdpError	False
unknown	Unknown	False
upstream_error	UpstreamError	False
unschedulable_error	UnschedulableError	False
extended	protobuf.Any	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.FeatureUnavailable

Name	Type	Description	Required
name	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.FileNotFound

Name	Type	Description	Required
filename	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.FragmentNotFound

Name	Type	Description	Required
fsha	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.FunctionError

Name	Type	Description	Required
retryable	boolean		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.GrpcMessageTooLarge

Name	Type	Description	Required
size	int64		False
limit	int64		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.IllegalArgument

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.ImagePullFailed

Name	Type	Description	Required
image_name	string		False
message	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.InsufficientResources

Name	Type	Description	Required
memory	InsufficientResources.Memory		False
cpu	InsufficientResources.Cpu		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.InsufficientResources.Cpu

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.InsufficientResources.Memory

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.InternalError

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.InternalServiceUnavailable

Name	Type	Description	Required
retry_after	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.InvalidConfig

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.InvalidCredentialsOnIdentityAssignment

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.InvalidSchema

Name	Type	Description	Required
schema	Schema		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.ListContentLimitExceeded

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.MysqlBadCredentials

Name	Type	Description	Required
mysql	Mysql.Location		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.MysqlDbDoesNotExist

Name	Type	Description	Required
mysql	Mysql.Location		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.MysqlError

Name	Type	Description	Required
mysql	Mysql.Location		False
user_friendly_message	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.NoSuchComponent

Name	Type	Description	Required
id	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.NoSuchTask

Name	Type	Description	Required
id	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.ObjectNotFound

Name	Type	Description	Required
missing_object	Object		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.SchemaInferenceError

Name	Type	Description	Required
retryable	boolean		False
log_label	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.TaskCanceled

Name	Type	Description	Required
task_id	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.TaskNotFound

Name	Type	Description	Required
task_id	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.TaskRejected

Name	Type	Description	Required
task_id	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.TooManyBadRecords

Name	Type	Description	Required
count	int64		False
error	List<TooManyBadRecords.ParseError>		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.TooManyBadRecords.ParseError

Name	Type	Required
line	int64	False
column	int64	False
message	string	False
file_name	string	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.UdpError

Name	Type	Description	Required
user_friendly_message	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.Unknown

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.UnschedulableError

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.fault.fault_pb2.UpstreamError

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Avro

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Avro.Formatter

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Avro.Parser

Name	Type	Description	Required
schema	Map		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Columns

Name	Type	Description	Required
parsing_specifications	List<Columns.ParsingSpecification>		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Columns.ParsingSpecification

Name	Type	Required
source_name	string	False
target_name	string	False
null_is_invalid	boolean	False
invalid_value_handling	Columns.ParsingSpecification.InvalidValueHandling	False
boolean	Boolean.Parser	False
date	Date.Parser	False
double	Double.Parser	False
float	Float.Parser	False
int	Int.Parser	False
long	Long.Parser	False
string	String.Parser	False
timestamp	Timestamp.Parser	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Columns.ParsingSpecification.InvalidValueHandling

Name	Type	Required
suppress_warn	boolean	False
use_default	Columns.ParsingSpecification.InvalidValueHandling.UseDefault	False
skip_record	Columns.ParsingSpecification.InvalidValueHandling.SkipRecord	False
fail	Columns.ParsingSpecification.InvalidValueHandling.Fail	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Columns.ParsingSpecification.InvalidValueHandling.Fail

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Columns.ParsingSpecification.InvalidValueHandling.SkipRecord

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Columns.ParsingSpecification.InvalidValueHandling.UseDefault

Name	Type	Description	Required
default_value	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Format

Name	Type	Required
avro	Avro	False
grok	Grok	False
json	Json	False
parquet	Parquet	False
xsv	Xsv	False
orc	Orc	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Grok

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Grok.Parser

Name	Type	Description	Required
pattern	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Json

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Json.Formatter

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Json.Parser

Name	Type	Required
columns	Columns	False
flatten_nested	boolean	False
max_warn_count	int64	False
namespace_delimiter	string	False
schema	Map	False
max_error_count	integer	False
max_error_percentage_points	number	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Lambda.Formatter

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Lambda.Parser

Name	Type	Required
docker_image	Lambda.Parser.DockerImage	False
code	Lambda.Parser.Code	False
metadata	string	False
schema	Map	False
max_error_count	integer	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Lambda.Parser.Code

Name	Type	Required
language	Lambda.Parser.Language	False
inline	string	False
file	Lambda.Parser.File	False
override_fingerprint	string	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Lambda.Parser.DockerImage

Name	Type	Description	Required
image_name	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Lambda.Parser.File

Name	Type	Description	Required
uri	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Lambda.Parser.Language

Name	Type	Description	Required
python	Lambda.Parser.Language.Python		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Lambda.Parser.Language.Python

Name	Type	Required
pip_package	List	False
v2	Lambda.Parser.Language.Python.V2	False
v3	Lambda.Parser.Language.Python.V3	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Lambda.Parser.Language.Python.V2

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Lambda.Parser.Language.Python.V3

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Orc

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Orc.Formatter

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Parquet

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Parquet.Formatter

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Parquet.Parser

Name	Type	Required
schema	Map	False
namespace_delimiter	string	False
require_no_missing_fields_in_parquet	boolean	False
require_no_extra_fields_in_parquet	boolean	False
require_field_type_match_schema	boolean	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Xsv

Name	Type	Description	Required
options	Xsv.Options		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Xsv.Formatter

Name	Type	Required
delimiter	string	False
include_header	boolean	False
line_ending	LineEnding	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Xsv.Options

Name	Type	Required
delimiter	string	False
include_header	boolean	False
line_ending	LineEnding	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.format.format_pb2.Xsv.Parser

Name	Type	Required
columns	Columns	False
comment_prefix	string	False
delimiter	string	False
escape_character	string	False
header_line_count	int64	False
max_warn_count	int64	False
quote_character	string	False
headers_to_columns	object	False
max_error_count	int64	False
max_error_percentage_points	number	False
schema	Map	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.function.function_pb2.Code.Language

Name	Type	Required
python	Code.Language.Python	False
java	Code.Language.Java	False
sql	Code.Language.Sql	False
snowflake_sql	Code.Language.SnowflakeSql	False
bigquery_sql	Code.Language.BigQuerySql	False
databricks_sql	Code.Language.DatabricksSql	False
snowpark	Code.Language.Snowpark	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.function.function_pb2.Code.Language.BigQuerySql

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.function.function_pb2.Code.Language.DatabricksSql

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.function.function_pb2.Code.Language.Java

Name	Type	Description	Required
class_name	string		False
argument	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.function.function_pb2.Code.Language.Python

Name	Type	Required
pip_package	List	False
class_name	string	False
v2	Code.Language.Python.Version.V2	False
v3	Code.Language.Python.Version.V3	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.function.function_pb2.Code.Language.Python.Version.V2

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.function.function_pb2.Code.Language.Python.Version.V3

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.function.function_pb2.Code.Language.SnowflakeSql

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.function.function_pb2.Code.Language.Snowpark

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.function.function_pb2.Code.Language.Sql

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.function.function_pb2.Environment

Runtime environment for user code.

Name	Type	Description	Required
spark_runtime	string	spark runtime - has the format "scala:<scala_ver>;spark:<spark_ver>", example - scala:2.12;spark:3.2.0.	False
container_image_label	string	a reference to an image that is registered in the Ascend environment.	False
container_image	Spark.ContainerImage	container image.	False
parent_spark_environment	Environment.Default	default spark environment inherited from parent entity - for example, the data service or site-level default.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.function.function_pb2.Environment.Default

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.function.function_pb2.QualityTests

Name	Type	Required
standard	List<QualityTests.StandardCheck>	False
custom	List<QualityTests.CustomCheck>	False
input	QualityTests.Input	False
failure_effect	List<QualityTests.FailureEffect>	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.function.function_pb2.QualityTests.CustomCheck

Name	Type	Required
sql	string	False
input	QualityTests.Input	False
failure_effect	List<QualityTests.FailureEffect>	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.function.function_pb2.QualityTests.FailureAction

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.function.function_pb2.QualityTests.FailureEffect

Name	Type	Required
action	QualityTests.FailureAction	False
threshold_count	uint64	False
threshold_fraction	number	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.function.function_pb2.QualityTests.Input

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.function.function_pb2.QualityTests.StandardCheck

Name	Type	Required
column	string	False
rule	string	False
value	Value	False
input	QualityTests.Input	False
failure_effect	List<QualityTests.FailureEffect>	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.google.google_pb2.api.HttpBody

Message that represents an arbitrary HTTP body. It should only be used for
payload formats that can't be represented as JSON, such as raw binary or
an HTML page.

This message can be used both in streaming and non-streaming API methods in
the request as well as the response.

It can be used as a top-level request field, which is convenient if one
wants to extract parameters from either the URL or HTTP template into the
request fields and also want access to the raw HTTP body.

Example:

message GetResourceRequest {
  // A unique request id.
  string request_id = 1;

  // The raw HTTP body is bound to this field.
  google.api.HttpBody http_body = 2;
}

service ResourceService {
  rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
  rpc UpdateResource(google.api.HttpBody) returns
  (google.protobuf.Empty);
}

Example with streaming methods:

service CaldavService {
  rpc GetCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);
  rpc UpdateCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);
}

Use of this type only changes how the request and response bodies are
handled, all other features will continue to work unchanged.

Name	Type	Description	Required
content_type	string	The HTTP Content-Type header value specifying the content type of the body.	False
data	byte	The HTTP request/response body as raw binary.	False
extensions	List<protobuf.Any>	Application specific response metadata. Must be set in the first response for streaming APIs.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.google.google_pb2.protobuf.Any

Any contains an arbitrary serialized protocol buffer message along with a
URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form
of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Example 2: Pack and unpack a message in Java.

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

 foo := &pb.Foo{...}
 any, err := anypb.New(foo)
 if err != nil {
   ...
 }
 ...
 foo := &pb.Foo{}
 if err := any.UnmarshalTo(foo); err != nil {
   ...
 }

The pack methods provided by protobuf library will by default use
'type.googleapis.com/full.type.name' as the type URL and the unpack
methods only use the fully qualified type name after the last '/'
in the type URL, for example "foo.bar.com/x/y.z" will yield type
name "y.z".

JSON

The JSON representation of an Any value uses the regular
representation of the deserialized, embedded message, with an
additional field @type which contains the type URL. Example:

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

If the embedded message type is well-known and has a custom JSON
representation, that representation will be embedded adding a field
value which holds the custom JSON in addition to the @type
field. Example (for message [google.protobuf.Duration][]):

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

Name	Type	Description	Required
type_url	string	A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: If no scheme is provided, `https` is assumed. An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.	False
value	byte	Must be a valid serialized protocol buffer of the above specified type.	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.google.google_pb2.protobuf.NullValue

NullValue is a singleton enumeration to represent the null value for the
Value type union.

The JSON representation for NullValue is JSON null.

NULL_VALUE: Null value.

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.grpc.grpc_pb2.gateway.runtime.Error

Name	Type	Required
error	string	False
code	integer	False
message	string	False
details	List<protobuf.Any>	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.grpc.grpc_pb2.gateway.runtime.StreamError

Name	Type	Required
grpc_code	integer	False
http_code	integer	False
message	string	False
http_status	string	False
details	List<protobuf.Any>	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Aws.Credentials

Name	Type	Required
id	string	False
secret	string	False
k8s_service_account	Aws.Credentials.AuthMethod.K8sServiceAccount	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Aws.Credentials.AuthMethod.K8sServiceAccount

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Aws.Redshift

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Aws.Redshift.Container

Name	Type	Required
credential_id	Credentials.Id	False
jdbc_url	string	False
staging_container	Aws.S3.Container	False
location_template	string	False
default_to_ssl	boolean	False
update_policy	UpdatePolicy	False
iam_role_arn	string	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Aws.Redshift.Credentials

Name	Type	Description	Required
username	string		False
password	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Aws.S3

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Aws.S3.Container

Name	Type	Required
credential_id	Credentials.Id	False
region	string	False
bucket	string	False
prefix	string	False
delimiter	string	False
disable_random_location_infix	boolean	False
location_template	string	False
location_suffix	string	False
manifest	Manifest	False
write_part_files	boolean	False
use_flat_part_file_layout	boolean	False
sse_kms_arn	string	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Aws.S3.Location

Name	Type	Description	Required
container	Aws.S3.Container		False
object_name	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Azure.Abs.Container

Name	Type	Required
account_name	string	False
credential_id	Credentials.Id	False
container	string	False
prefix	string	False
delimiter	string	False
disable_random_location_infix	boolean	False
location_template	string	False
location_suffix	string	False
manifest	Manifest	False
write_part_files	boolean	False
use_flat_part_file_layout	boolean	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Azure.Credentials

Name	Type	Required
shared_key	Azure.Credentials.SharedKey	False
service_principal	Azure.Credentials.ServicePrincipal	False
service_principal_json	Azure.Credentials.ServicePrincipalJson	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Azure.Credentials.ServicePrincipal

Name	Type	Required
client_id	string	False
client_secret	string	False
tenant	string	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Azure.Credentials.ServicePrincipalJson

Name	Type	Description	Required
json_key	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Azure.Credentials.SharedKey

Name	Type	Description	Required
key	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Code

Name	Type	Required
language	Code.Language	False
source	Code.Source	False
environment	Environment	False
additional_source	Code.Source	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Code.Source

Name	Type	Required
inline	string	False
location	Code.Source.Location	False
built_in		False
override_fingerprint	string	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Code.Source.Location

Name	Type	Description	Required
container	Container		False
pattern	Pattern		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Connection

Name	Type	Required
type_id	Type.Id	False
id	Id	False
name	string	False
details	object	False
credential_id	Credentials.Id	False
entity_metadata	Connection.EntityMetadata	False
access_mode	AccessMode	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Connection.Asset.Record

Name	Type	Description	Required
connection_id	Id		False
details	object		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Connection.EntityMetadata

Name	Type	Required
created_at	string	False
updated_at	string	False
owner_orgs	List<Connection.EntityMetadata.Org>	False
id	string	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Connection.EntityMetadata.Org

Name	Type	Description	Required
org_id	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Connection.Type

Name	Type	Required
id	Type.Id	False
name	string	False
version	string	False
executable	Executable	False
alternative_credential_type	List<Type.Id>	False
status	Type.Status	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Container

Name	Type	Required
redshift	Aws.Redshift.Container	False
s3	Aws.S3.Container	False
abs	Azure.Abs.Container	False
record_connection	Connection.Asset.Record	False
file	File.Container	False
byte_function	Function.Container.Byte	False
record_function	Function.Container.Record	False
big_query	Gcp.BigQuery.Container	False
gcs	Gcp.Gcs.Container	False
immediate	Immediate.Container	False
ms_sql_server	MsSqlServer.Container	False
mysql	Mysql.Container	False
mysql_partition	Mysql.Partition.Container	False
snowflake	Snowflake.Container	False
spark	Spark.Container	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Container.ShaOverrides

Name	Type	Description	Required
csha	byte		False
read_io_sha	byte		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Credentials

Name	Type	Required
id	Credentials.Id	False
aws	Aws.Credentials	False
redshift	Aws.Redshift.Credentials	False
azure	Azure.Credentials	False
function	Function.Credentials	False
gcp	Gcp.Credentials	False
ms_sql_server	MsSqlServer.Credentials	False
mysql	Mysql.Credentials	False
snowflake	Snowflake.Credentials	False
connection	Credentials	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Credentials.Id

Name	Type	Description	Required
value	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Executable

Name	Type	Description	Required
code	Code		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.File.Container

Name	Type	Description	Required
prefix	string		False
location_template	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Function.Container

Name	Type	Description	Required
executable	Executable		False
credentials_configuration	Function.CredentialsConfiguration		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Function.Container.Byte

Name	Type	Description	Required
container	Function.Container		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Function.Container.Record

Name	Type	Description	Required
container	Function.Container		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Function.Credentials

Name	Type	Description	Required
secret	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Function.CredentialsConfiguration

Name	Type	Description	Required
id	Credentials.Id		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Gcp.BigQuery

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Gcp.BigQuery.Container

Name	Type	Required
credential_id	Credentials.Id	False
project	string	False
dataset_prefix	string	False
location_template	string	False
partition_pattern	Pattern	False
staging_container	Gcp.Gcs.Container	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Gcp.Credentials

Name	Type	Description	Required
json_key	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Gcp.Gcs

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Gcp.Gcs.Container

Name	Type	Required
credential_id	Credentials.Id	False
bucket	string	False
prefix	string	False
delimiter	string	False
disable_random_location_infix	boolean	False
location_template	string	False
location_suffix	string	False
manifest	Manifest	False
write_part_files	boolean	False
use_flat_part_file_layout	boolean	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Immediate.Container

Name	Type	Required
content_some	byte	False
content_none		False
object	List<Immediate.Object>	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Immediate.Object

Name	Type	Required
name	string	False
length	int64	False
content_sha	byte	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Manifest

Name	Type	Description	Required
name	string		False
format	Manifest.Format		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Manifest.Csv

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Manifest.Format

Name	Type	Description	Required
json	Manifest.Json		False
csv	Manifest.Csv		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Manifest.Json

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.MsSqlServer.Container

Name	Type	Required
credential_id	Credentials.Id	False
server_name	string	False
port	integer	False
use_encryption	boolean	False
database_name	string	False
abs	Azure.Abs.Container	False
location_template	string	False
update_policy	UpdatePolicy	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.MsSqlServer.Credentials

Name	Type	Description	Required
sql_authentication	MsSqlServer.Credentials.SqlAuthentication		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.MsSqlServer.Credentials.SqlAuthentication

Name	Type	Description	Required
user	string		False
password	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Mysql

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Mysql.Container

Name	Type	Required
credential_id	Credentials.Id	False
host	string	False
port	integer	False
database	string	False
location_template	string	False
disable_tls	boolean	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Mysql.Credentials

Name	Type	Required
username	string	False
password	string	False
certificate	Mysql.TlsCertificate	False
auth_method	Mysql.Credentials.AuthMethod	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Mysql.Credentials.AuthMethod

Name	Type	Description	Required
aws_iam	Mysql.Credentials.AuthMethod.AwsIam		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Mysql.Credentials.AuthMethod.AwsIam

Name	Type	Description	Required
region	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Mysql.Location

Name	Type	Required
container	Mysql.Container	False
table_name	string	False
schema	Map	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Mysql.Partition.Container

Name	Type	Required
credential_id	Credentials.Id	False
host	string	False
port	integer	False
database	string	False
table	string	False
location_template	string	False
disable_tls	boolean	False
sha_overrides	Container.ShaOverrides	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Mysql.TlsCertificate

Name	Type	Required
server_ca	string	False
client_cert	string	False
client_key	string	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Snowflake.Container

Name	Type	Required
credential_id	Credentials.Id	False
update_policy	UpdatePolicy	False
s3	Aws.S3.Container	False
gcs	Gcp.Gcs.Container	False
abs	Azure.Abs.Container	False
location_template	string	False
account	string	False
warehouse	string	False
database	string	False
snowflake_schema	string	False
role	string	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Snowflake.Credentials

Name	Type	Description	Required
username	string		False
password	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Spark.Container

Name	Type	Description	Required
store	Spark.Store		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.io.io_pb2.Spark.Store

Name	Type	Required
s3	Aws.S3.Container	False
gcs	Gcp.Gcs.Container	False
abs	Azure.Abs.Container	False
format	Format	False
content_encoding	ContentEncoding	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.ComputeConfiguration

Name	Type	Description	Required
spark_job	Spark.JobConfiguration		False
tests	QualityTests		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.Granularity

Granularity of temporal partitioning, e.g., when doing partial
reductions.

Name	Type	Description	Required
time	Granularity.Time		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.Granularity.Time

Name	Type	Required
auto	Granularity.Time.Auto	False
year	Granularity.Time.Year	False
month	Granularity.Time.Month	False
day	Granularity.Time.Day	False
hour	Granularity.Time.Hour	False
minute	Granularity.Time.Minute	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.Granularity.Time.Auto

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.Granularity.Time.Day

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.Granularity.Time.Hour

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.Granularity.Time.Minute

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.Granularity.Time.Month

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.Granularity.Time.Year

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.InputInfo

Name	Type	Required
index	integer	False
uuid	string	False
type	string	False
id	string	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.InstanceType

Name	Type	Required
small	InstanceType.Small	False
medium	InstanceType.Medium	False
large	InstanceType.Large	False
xlarge	InstanceType.XLarge	False
x2large	InstanceType.X2Large	False
x4large	InstanceType.X4Large	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.InstanceType.Large

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.InstanceType.Medium

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.InstanceType.Small

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.InstanceType.X2Large

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.InstanceType.X4Large

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.InstanceType.XLarge

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.Operator

Name	Type	Required
avro_formatter	Avro.Formatter	False
avro_parser	Avro.Parser	False
grok_parser	Grok.Parser	False
json_formatter	Json.Formatter	False
json_parser	Json.Parser	False
lambda_formatter	Lambda.Formatter	False
lambda_parser	Lambda.Parser	False
orc_formatter	Orc.Formatter	False
parquet_formatter	Parquet.Formatter	False
parquet_parser	Parquet.Parser	False
xsv_formatter	Xsv.Formatter	False
xsv_parser	Xsv.Parser	False
spark_function	Spark.Function	False
sql_query	Sql.Query	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.RecursionSpecification

Name	Type	Description	Required
seed_data_index	integer		False
retention_policy	RecursionSpecification.RetentionPolicy		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.RecursionSpecification.RetentionPolicy

Name	Type	Description	Required
all	RecursionSpecification.RetentionPolicy.All		False
last_n	RecursionSpecification.RetentionPolicy.LastN		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.RecursionSpecification.RetentionPolicy.All

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.RecursionSpecification.RetentionPolicy.LastN

Name	Type	Description	Required
n	integer		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.Reduction

Name	Type	Required
full	Reduction.Full	False
no_reduction	Reduction.NoReduction	False
partial	Reduction.Partial	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.Reduction.Full

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.Reduction.NoReduction

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.Reduction.Partial

Name	Type	Description	Required
partition_by	object		False
recursion_specification	RecursionSpecification		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.Reduction.Partial.PartitionSpecification

Name	Type	Description	Required
column	string		False
granularity	Granularity		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.Spark.Filter

Name	Type	Description	Required
function	Spark.Filter.Function		False
composite	Spark.Filter.Composite		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.Spark.Filter.Composite

Name	Type	Description	Required
operator	Spark.Filter.Composite.Operator		False
filters	List<Spark.Filter>		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.Spark.Filter.Composite.Operator

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.Spark.Filter.Function

Name	Type	Description	Required
name	string		False
args	List		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.Spark.Function

Name	Type	Required
executable	Executable	False
reduction	Reduction	False
credentials_configuration	Function.CredentialsConfiguration	False
job_configuration	Spark.JobConfiguration	False
additional_input_configs	object	False
tests	QualityTests	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.Spark.Function.AdditionalInputConfig

Name	Type	Required
required_metadata_columns	List	False
filter	Spark.Filter	False
unioned_inputs	List<InputInfo>	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.Spark.JobConfiguration

Name	Type	Required
executor_instances	integer	False
executor_instance_type	InstanceType	False
driver_instance_type	InstanceType	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.operator.operator_pb2.Sql.Query

Name	Type	Required
sql	string	False
spark_job_configuration	Spark.JobConfiguration	False
override_fingerprint	string	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.pattern.pattern_pb2.Pattern

Name	Type	Required
glob	string	False
regex	string	False
exact_match	string	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.preview.preview_pb2.Response

Name	Type	Description	Required
text_response	Response.TextResponse		False
records_response	Response.RecordsResponse		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.preview.preview_pb2.Response.RecordsResponse

Name	Type	Required
component_id	Id	False
records	RecordsRead	False
schema	Map	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.preview.preview_pb2.Response.TextResponse

Name	Type	Description	Required
line	List		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.schema.schema_pb2.Array

Name	Type	Description	Required
element_schema	Schema		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.schema.schema_pb2.Binary

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.schema.schema_pb2.Boolean

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.schema.schema_pb2.Boolean.Parser

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.schema.schema_pb2.Byte

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.schema.schema_pb2.Char

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.schema.schema_pb2.Date

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.schema.schema_pb2.Date.Parser

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.schema.schema_pb2.Decimal

Name	Type	Description	Required
precision	integer		False
scale	integer		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.schema.schema_pb2.Dictionary

Name	Type	Description	Required
key_schema	Schema		False
value_schema	Schema		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.schema.schema_pb2.Double

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.schema.schema_pb2.Double.Parser

Name	Type	Description	Required
decimal_separator	string		False
thousands_separator	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.schema.schema_pb2.Field

Name	Type	Description	Required
name	string		False
schema	Schema		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.schema.schema_pb2.Float

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.schema.schema_pb2.Float.Parser

Name	Type	Description	Required
decimal_separator	string		False
thousands_separator	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.schema.schema_pb2.Int

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.schema.schema_pb2.Int.Parser

Name	Type	Description	Required
thousands_separator	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.schema.schema_pb2.Long

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.schema.schema_pb2.Long.Parser

Name	Type	Description	Required
thousands_separator	string		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.schema.schema_pb2.Map

Name	Type	Description	Required
field	List<Field>		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.schema.schema_pb2.Nothing

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.schema.schema_pb2.Schema

Name	Type	Required
array	Array	False
boolean	Boolean	False
byte	Byte	False
char	Char	False
date	Date	False
double	Double	False
float	Float	False
int	Int	False
long	Long	False
map	Map	False
nothing	Nothing	False
string	String	False
timestamp	Timestamp	False
short	Short	False
decimal	Decimal	False
binary	Binary	False
dictionary	Dictionary	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.schema.schema_pb2.Short

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.schema.schema_pb2.String

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.schema.schema_pb2.String.Parser

Name	Type	Description	Required
trim	boolean		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.schema.schema_pb2.Timestamp

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.schema.schema_pb2.Timestamp.Parser

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.schema.schema_pb2.UpdatePolicy

Name	Type	Required
error	UpdatePolicy.Error	False
drop_table	UpdatePolicy.DropTable	False
alter_table	UpdatePolicy.AlterTable	False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.schema.schema_pb2.UpdatePolicy.AlterTable

Name	Type	Description	Required
alter_columns_on_type_mismatch	boolean		False
drop_unknown_columns	boolean		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.schema.schema_pb2.UpdatePolicy.DropTable

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.schema.schema_pb2.UpdatePolicy.Error

Object has no properties

[Back to top] [Back to API list] [Back to Models]

ascend.protos.spark_manager.spark_manager_pb2.SparkClusterPool.Status.Response

Name	Type	Description	Required
cluster_pool_id	string		False
cluster_statuses	List<SparkClusterStatus>		False

[Back to top] [Back to API list] [Back to Models]

ascend.protos.text.text_pb2.LineEnding

Name	Type	Required
cr	LineEnding.Cr	False
cr_lf	LineEnding.CrLf	False
lf	LineEnding.Lf	False
lf_cr	LineEnding.LfCr	False
ff	LineEnding.Ff	False
ls	LineEnding.Ls	False
nel	LineEnding.Nel	False
ps	LineEnding.Ps	False
vt	LineEnding.Vt	False