Class FeaturesClient

Constructors

constructor

new FeaturesClient(options: ClientOptions): FeaturesClient
Parameters
- options: ClientOptions
Returns FeaturesClient
- Defined in client.ts:86

Methods

batchCreateMaterializedFeatures

batchCreateMaterializedFeatures(
req: BatchCreateMaterializedFeaturesRequest,
options?: CallOptions,
): Promise<BatchCreateMaterializedFeaturesResponse>
Batch create materialized features.
Parameters
- req: BatchCreateMaterializedFeaturesRequest
- Optionaloptions: CallOptions
Returns Promise<BatchCreateMaterializedFeaturesResponse>
- Defined in client.ts:102

createFeature

createFeature(
req: CreateFeatureRequest,
options?: CallOptions,
): Promise<Feature>
Create a Feature.
Parameters
- req: CreateFeatureRequest
- Optionaloptions: CallOptions
Returns Promise<Feature>
- Defined in client.ts:138

createKafkaConfig

createKafkaConfig(
req: CreateKafkaConfigRequest,
options?: CallOptions,
): Promise<KafkaConfig>
Create a Kafka config. During PrPr, Kafka configs can be read and used when creating features under the entire metastore. Only the creator of the Kafka config can delete it.
Parameters
- req: CreateKafkaConfigRequest
- Optionaloptions: CallOptions
Returns Promise<KafkaConfig>
- Defined in client.ts:172

createMaterializedFeature

createMaterializedFeature(
req: CreateMaterializedFeatureRequest,
options?: CallOptions,
): Promise<MaterializedFeature>
Create a materialized feature.
Parameters
- req: CreateMaterializedFeatureRequest
- Optionaloptions: CallOptions
Returns Promise<MaterializedFeature>
- Defined in client.ts:202

createStream

createStream(req: CreateStreamRequest, options?: CallOptions): Promise<Stream>
Create a Stream, a governed UC entity representing an external streaming data source.
Parameters
- req: CreateStreamRequest
- Optionaloptions: CallOptions
Returns Promise<Stream>
- Defined in client.ts:235

deleteFeature

deleteFeature(req: DeleteFeatureRequest, options?: CallOptions): Promise<void>
Delete a Feature.
Parameters
- req: DeleteFeatureRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:265

deleteKafkaConfig

deleteKafkaConfig(
req: DeleteKafkaConfigRequest,
options?: CallOptions,
): Promise<void>
Delete a Kafka config. During PrPr, Kafka configs can be read and used when creating features under the entire metastore. Only the creator of the Kafka config can delete it.
Parameters
- req: DeleteKafkaConfigRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:292

deleteMaterializedFeature

deleteMaterializedFeature(
req: DeleteMaterializedFeatureRequest,
options?: CallOptions,
): Promise<void>
Delete a materialized feature.
Parameters
- req: DeleteMaterializedFeatureRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:315

deleteStream

deleteStream(req: DeleteStreamRequest, options?: CallOptions): Promise<void>
Delete a Stream by its full three-part name (catalog.schema.stream).
Parameters
- req: DeleteStreamRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:338

getFeature

getFeature(req: GetFeatureRequest, options?: CallOptions): Promise<Feature>
Get a Feature.
Parameters
- req: GetFeatureRequest
- Optionaloptions: CallOptions
Returns Promise<Feature>
- Defined in client.ts:361

getKafkaConfig

getKafkaConfig(
req: GetKafkaConfigRequest,
options?: CallOptions,
): Promise<KafkaConfig>
Get a Kafka config. During PrPr, Kafka configs can be read and used when creating features under the entire metastore. Only the creator of the Kafka config can delete it.
Parameters
- req: GetKafkaConfigRequest
- Optionaloptions: CallOptions
Returns Promise<KafkaConfig>
- Defined in client.ts:394

getMaterializedFeature

getMaterializedFeature(
req: GetMaterializedFeatureRequest,
options?: CallOptions,
): Promise<MaterializedFeature>
Get a materialized feature.
Parameters
- req: GetMaterializedFeatureRequest
- Optionaloptions: CallOptions
Returns Promise<MaterializedFeature>
- Defined in client.ts:423

getStream

getStream(req: GetStreamRequest, options?: CallOptions): Promise<Stream>
Get a Stream by its full three-part name (catalog.schema.stream).
Parameters
- req: GetStreamRequest
- Optionaloptions: CallOptions
Returns Promise<Stream>
- Defined in client.ts:452

listFeatures

listFeatures(
req: ListFeaturesRequest,
options?: CallOptions,
): Promise<ListFeaturesResponse>
List Features.
Parameters
- req: ListFeaturesRequest
- Optionaloptions: CallOptions
Returns Promise<ListFeaturesResponse>
- Defined in client.ts:481

listFeaturesIter

listFeaturesIter(
req: ListFeaturesRequest,
options?: CallOptions,
): AsyncGenerator<Feature>
Parameters
- req: ListFeaturesRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<Feature>
- Defined in client.ts:524

listKafkaConfigs

listKafkaConfigs(
req: ListKafkaConfigsRequest,
options?: CallOptions,
): Promise<ListKafkaConfigsResponse>
List Kafka configs. During PrPr, Kafka configs can be read and used when creating features under the entire metastore. Only the creator of the Kafka config can delete it.
Parameters
- req: ListKafkaConfigsRequest
- Optionaloptions: CallOptions
Returns Promise<ListKafkaConfigsResponse>
- Defined in client.ts:546

listKafkaConfigsIter

listKafkaConfigsIter(
req: ListKafkaConfigsRequest,
options?: CallOptions,
): AsyncGenerator<KafkaConfig>
Parameters
- req: ListKafkaConfigsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<KafkaConfig>
- Defined in client.ts:583

listMaterializedFeatures

listMaterializedFeatures(
req: ListMaterializedFeaturesRequest,
options?: CallOptions,
): Promise<ListMaterializedFeaturesResponse>
List materialized features.
Parameters
- req: ListMaterializedFeaturesRequest
- Optionaloptions: CallOptions
Returns Promise<ListMaterializedFeaturesResponse>
- Defined in client.ts:601

listMaterializedFeaturesIter

listMaterializedFeaturesIter(
req: ListMaterializedFeaturesRequest,
options?: CallOptions,
): AsyncGenerator<MaterializedFeature>
Parameters
- req: ListMaterializedFeaturesRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<MaterializedFeature>
- Defined in client.ts:644

listStreams

listStreams(
req: ListStreamsRequest,
options?: CallOptions,
): Promise<ListStreamsResponse>
List Streams under a given catalog.schema parent.
Parameters
- req: ListStreamsRequest
- Optionaloptions: CallOptions
Returns Promise<ListStreamsResponse>
- Defined in client.ts:662

listStreamsIter

listStreamsIter(
req: ListStreamsRequest,
options?: CallOptions,
): AsyncGenerator<Stream>
Parameters
- req: ListStreamsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<Stream>
- Defined in client.ts:702

updateFeature

updateFeature(
req: UpdateFeatureRequest,
options?: CallOptions,
): Promise<Feature>
Update a Feature.
Parameters
- req: UpdateFeatureRequest
- Optionaloptions: CallOptions
Returns Promise<Feature>
- Defined in client.ts:720

updateKafkaConfig

updateKafkaConfig(
req: UpdateKafkaConfigRequest,
options?: CallOptions,
): Promise<KafkaConfig>
Update a Kafka config. During PrPr, Kafka configs can be read and used when creating features under the entire metastore. Only the creator of the Kafka config can delete it.
Parameters
- req: UpdateKafkaConfigRequest
- Optionaloptions: CallOptions
Returns Promise<KafkaConfig>
- Defined in client.ts:766

updateMaterializedFeature

updateMaterializedFeature(
req: UpdateMaterializedFeatureRequest,
options?: CallOptions,
): Promise<MaterializedFeature>
Update a materialized feature (pause/resume).
Parameters
- req: UpdateMaterializedFeatureRequest
- Optionaloptions: CallOptions
Returns Promise<MaterializedFeature>
- Defined in client.ts:808

updateStream

updateStream(req: UpdateStreamRequest, options?: CallOptions): Promise<Stream>
Update a Stream. Only fields listed in update_mask are mutated.
Parameters
- req: UpdateStreamRequest
- Optionaloptions: CallOptions
Returns Promise<Stream>
- Defined in client.ts:853