Skip to content

add comments on field behavior #248

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
parthban-db wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add comments on field behavior #248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
668 changes: 334 additions & 334 deletions package-lock.json
View file
Open in desktop

Large diffs are not rendered by default.

55 changes: 49 additions & 6 deletions packages/accessmanagement/src/v1/model.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,24 +110,32 @@ export interface Actor {
}

export interface CheckPolicyRequest {
/** Required. This field must be set in requests. */
actor?: Actor | undefined;
/** Required. This field must be set in requests. */
permission?: string | undefined;
/**
* Ex: (servicePrincipal/use, accounts/<account-id>/servicePrincipals/<sp-id>)
* Ex: (servicePrincipal.ruleSet/update, accounts/<account-id>/servicePrincipals/<sp-id>/ruleSets/default)
*
* Required. This field must be set in requests.
*/
resource?: string | undefined;
/** Required. This field must be set in requests. */
consistencyToken?: ConsistencyToken | undefined;
/** Required. This field must be set in requests. */
authzIdentity?: RequestAuthzIdentity | undefined;
resourceInfo?: ResourceInfo | undefined;
}

export interface CheckPolicyResponse {
isPermitted?: boolean | undefined;
/** Required. This field must be set in requests. */
consistencyToken?: ConsistencyToken | undefined;
}

export interface ConsistencyToken {
/** Required. This field must be set in requests. */
value?: string | undefined;
}

Expand Down Expand Up @@ -163,6 +171,8 @@ export interface GetRuleSetRequest {
* `name=accounts/<ACCOUNT_ID>/groups/<GROUP_ID>/ruleSets/default` | A name for a rule set on the group.
* `name=accounts/<ACCOUNT_ID>/servicePrincipals/<SERVICE_PRINCIPAL_APPLICATION_ID>/ruleSets/default` | A name for a rule set on the service principal.
* `name=accounts/<ACCOUNT_ID>/tagPolicies/<TAG_POLICY_ID>/ruleSets/default` | A name for a rule set on the tag policy.
*
* Required. This field must be set in requests.
*/
name?: string | undefined;
/**
Expand All @@ -176,6 +186,8 @@ export interface GetRuleSetRequest {
* :--- | :---
* `etag=` | An empty etag can only be used in GET to indicate no freshness requirements.
* `etag=RENUAAABhSweA4NvVmmUYdiU717H3Tgy0UJdor3gE4a+mq/oj9NjAf8ZsQ==` | An etag encoded a specific version of the rule set to get or to be updated.
*
* Required. This field must be set in requests.
*/
etag?: string | undefined;
}
Expand All @@ -190,7 +202,11 @@ export interface GrantRule {
* * servicePrincipals/<SERVICE_PRINCIPAL_APPLICATION_ID>
*/
principals?: string[] | undefined;
/** Role that is assigned to the list of principals. */
/**
* Role that is assigned to the list of principals.
*
* Required. This field must be set in requests.
*/
role?: string | undefined;
}

Expand All @@ -206,6 +222,8 @@ export interface ListAssignableRolesForResourceRequest {
* `resource=accounts/<ACCOUNT_ID>/groups/<GROUP_ID>` | A resource name for the group.
* `resource=accounts/<ACCOUNT_ID>/servicePrincipals/<SP_ID>` | A resource name for the service principal.
* `resource=accounts/<ACCOUNT_ID>/tagPolicies/<TAG_POLICY_ID>` | A resource name for the tag policy.
*
* Required. This field must be set in requests.
*/
resource?: string | undefined;
}
Expand Down Expand Up @@ -300,7 +318,11 @@ export interface PrincipalOutput {
}

export interface ResourceInfo {
/** Id of the current resource. */
/**
* Id of the current resource.
*
* Required. This field must be set in requests.
*/
id?: string | undefined;
/** Parent resource info for the current resource. The parent may have another parent. */
parentResourceInfo?: ResourceInfo | undefined;
Expand All @@ -309,12 +331,20 @@ export interface ResourceInfo {
}

export interface Role {
/** Role to assign to a principal or a list of principals on a resource. */
/**
* Role to assign to a principal or a list of principals on a resource.
*
* Required. This field must be set in requests.
*/
name?: string | undefined;
}

export interface RuleSet {
/** Name of the rule set. */
/**
* Name of the rule set.
*
* Required. This field must be set in requests.
*/
name?: string | undefined;
/**
* Identifies the version of the rule set returned.
Expand All @@ -324,13 +354,19 @@ export interface RuleSet {
* make use of the etag in the read -> modify -> write pattern to perform rule set updates in
* order to avoid race conditions that is get an etag from a GET rule set request, and pass it
* with the PUT update request to identify the rule set version you are updating.
*
* Required. This field must be set in requests.
*/
etag?: string | undefined;
grantRules?: GrantRule[] | undefined;
}

export interface RuleSetUpdateRequest {
/** Name of the rule set. */
/**
* Name of the rule set.
*
* Required. This field must be set in requests.
*/
name?: string | undefined;
/**
* Identifies the version of the rule set returned.
Expand All @@ -340,6 +376,8 @@ export interface RuleSetUpdateRequest {
* make use of the etag in the read -> modify -> write pattern to perform rule set updates in
* order to avoid race conditions that is get an etag from a GET rule set request, and pass it
* with the PUT update request to identify the rule set version you are updating.
*
* Required. This field must be set in requests.
*/
etag?: string | undefined;
grantRules?: GrantRule[] | undefined;
Expand All @@ -364,8 +402,13 @@ export interface UpdateObjectPermissionsRequest {
export interface UpdateRuleSetRequest {
/** <Databricks> account ID. */
accountId?: string | undefined;
/** Name of the rule set. */
/**
* Name of the rule set.
*
* Required. This field must be set in requests.
*/
name?: string | undefined;
/** Required. This field must be set in requests. */
ruleSet?: RuleSetUpdateRequest | undefined;
}

Expand Down
1 change: 1 addition & 0 deletions packages/alerts/src/v1/model.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,7 @@ export interface TrashAlertRequest {

export interface UpdateAlertRequest {
alert?: UpdateAlertRequestAlert | undefined;
/** Required. This field must be set in requests. */
updateMask?: FieldMask<UpdateAlertRequestAlert> | undefined;
id?: string | undefined;
/** If true, automatically resolve alert display name conflicts. Otherwise, fail the request if the alert's display name conflicts with an existing alert's display name. */
Expand Down
82 changes: 70 additions & 12 deletions packages/alerts/src/v2/model.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,31 +73,65 @@ export type SchedulePauseStatus =
| (string & {});

export interface Alert {
/** UUID identifying the alert. */
/**
* UUID identifying the alert.
*
* Output only. The server sets this field in responses; any value sent in a request is ignored.
*/
id?: string | undefined;
/** The display name of the alert. */
/**
* The display name of the alert.
*
* Required. This field must be set in requests.
*/
displayName?: string | undefined;
/** The owner's username. This field is set to "Unavailable" if the user has been deleted. */
/**
* The owner's username. This field is set to "Unavailable" if the user has been deleted.
*
* Output only. The server sets this field in responses; any value sent in a request is ignored.
*/
ownerUserName?: string | undefined;
/** The timestamp indicating when the alert was created. */
/**
* The timestamp indicating when the alert was created.
*
* Output only. The server sets this field in responses; any value sent in a request is ignored.
*/
createTime?: Temporal.Instant | undefined;
/** The timestamp indicating when the alert was updated. */
/**
* The timestamp indicating when the alert was updated.
*
* Output only. The server sets this field in responses; any value sent in a request is ignored.
*/
updateTime?: Temporal.Instant | undefined;
/** The workspace path of the folder containing the alert. Can only be set on create, and cannot be updated. */
parentPath?: string | undefined;
/** Text of the query to be run. */
/**
* Text of the query to be run.
*
* Required. This field must be set in requests.
*/
queryText?: string | undefined;
/** ID of the SQL warehouse attached to the alert. */
/**
* ID of the SQL warehouse attached to the alert.
*
* Required. This field must be set in requests.
*/
warehouseId?: string | undefined;
/**
* The run as username or application ID of service principal.
* On Create and Update, this field can be set to application ID of an active service principal. Setting this field requires the servicePrincipal/user role.
* Deprecated: Use `run_as` field instead. This field will be removed in a future release.
*/
runAsUserName?: string | undefined;
/** Required. This field must be set in requests. */
evaluation?: AlertEvaluation | undefined;
/** Required. This field must be set in requests. */
schedule?: CronSchedule | undefined;
/** Indicates whether the query is trashed. */
/**
* Indicates whether the query is trashed.
*
* Output only. The server sets this field in responses; any value sent in a request is ignored.
*/
lifecycleState?: AlertLifecycleState | undefined;
/** Custom summary for the alert. support mustache template. */
customSummary?: string | undefined;
Expand All @@ -115,22 +149,40 @@ export interface Alert {
* The actual identity that will be used to execute the alert.
* This is an output-only field that shows the resolved run-as identity after applying
* permissions and defaults.
*
* Output only. The server sets this field in responses; any value sent in a request is ignored.
*/
effectiveRunAs?: AlertRunAs | undefined;
}

export interface AlertEvaluation {
/** Source column from result to use to evaluate alert */
/**
* Source column from result to use to evaluate alert
*
* Required. This field must be set in requests.
*/
source?: AlertOperandColumn | undefined;
/** Operator used for comparison in alert evaluation. */
/**
* Operator used for comparison in alert evaluation.
*
* Required. This field must be set in requests.
*/
comparisonOperator?: ComparisonOperator | undefined;
/** Threshold to user for alert evaluation, can be a column or a value. */
threshold?: AlertOperand | undefined;
/** User or Notification Destination to notify when alert is triggered. */
notification?: AlertNotification | undefined;
/** Latest state of alert evaluation. */
/**
* Latest state of alert evaluation.
*
* Output only. The server sets this field in responses; any value sent in a request is ignored.
*/
state?: AlertEvaluationState | undefined;
/** Timestamp of the last evaluation. */
/**
* Timestamp of the last evaluation.
*
* Output only. The server sets this field in responses; any value sent in a request is ignored.
*/
lastEvaluatedAt?: Temporal.Instant | undefined;
/** Alert state if result is empty. Please avoid setting this field to be `UNKNOWN` because `UNKNOWN` state is planned to be deprecated. */
emptyResultState?: AlertEvaluationState | undefined;
Expand All @@ -157,6 +209,7 @@ export interface AlertOperand {
}

export interface AlertOperandColumn {
/** Required. This field must be set in requests. */
name?: string | undefined;
display?: string | undefined;
/** If not set, the behavior is equivalent to using `First row` in the UI. */
Expand Down Expand Up @@ -202,12 +255,16 @@ export interface CronSchedule {
/**
* A cron expression using quartz syntax that specifies the schedule for this pipeline.
* Should use the quartz format described here: http://www.quartz-scheduler.org/documentation/quartz-2.1.7/tutorials/tutorial-lesson-06.html
*
* Required. This field must be set in requests.
*/
quartzCronSchedule?: string | undefined;
/**
* A Java timezone id. The schedule will be resolved using this timezone.
* This will be combined with the quartz_cron_schedule to determine the schedule.
* See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.
*
* Required. This field must be set in requests.
*/
timezoneId?: string | undefined;
/** Indicate whether this schedule is paused or not. */
Expand Down Expand Up @@ -243,6 +300,7 @@ export interface TrashAlertRequest {

export interface UpdateAlertRequest {
alert?: Alert | undefined;
/** Required. This field must be set in requests. */
updateMask?: FieldMask<Alert> | undefined;
}

Expand Down
Loading
Loading