Asset Review

View as Markdown

Create a review (e.g. approval) for an assetPOST /api/2.0/clean-rooms/{clean_room_name}/assets/{asset_type}/{name}/reviews

CreateCleanRoomAssetReviewResponse object

notebook_reviewsarray of objectBeta

All existing notebook approvals or rejections

Show child attributesHide child attributes

reviewer_collaborator_aliasstring

Collaborator alias of the reviewer

created_at_millisint64

When the review was submitted, in epoch milliseconds

review_statestring

Review outcome

Values:

• NOTEBOOK_REVIEW_STATE_UNSPECIFIED
• APPROVED
• REJECTED
• PENDING

commentstring<= 500 characters

Review comment

Example: Code looks wrong

review_sub_reasonstring

Specified when the review was not explicitly made by a user

Values:

• NOTEBOOK_REVIEW_SUB_REASON_UNSPECIFIED
• BACKFILLED
• AUTO_APPROVED

jar_analysis_reviewsarray of objectBeta

All existing jar analysis approvals or rejections

Show child attributesHide child attributes

reviewer_collaborator_aliasstringPublic Preview

collaborator alias of the reviewer

created_at_millisint64Public Preview

timestamp of when the review was submitted

review_statestringPublic Preview

review outcome

Values:

• JAR_ANALYSIS_REVIEW_STATE_UNSPECIFIED
• APPROVED
• REJECTED
• PENDING

commentstring<= 500 charactersPublic Preview

review comment

Example: Not ready to run yet

review_sub_reasonstringPublic Preview

specified when the review was not explicitly made by a user

Values:

• JAR_ANALYSIS_REVIEW_SUB_REASON_UNSPECIFIED
• AUTO_APPROVED

notebook_review_statestringBeta

Top-level status derived from all reviews

Values:

• NOTEBOOK_REVIEW_STATE_UNSPECIFIED
• APPROVED
• REJECTED
• PENDING

jar_analysis_review_statestringBeta

top-level status derived from all reviews

Values:

• JAR_ANALYSIS_REVIEW_STATE_UNSPECIFIED
• APPROVED
• REJECTED
• PENDING

View as Markdown

The CreateCleanRoomAssetReviewResponse object

{
  "notebook_reviews": [
    {
      "reviewer_collaborator_alias": "string",
      "created_at_millis": 0,
      "review_state": "APPROVED",
      "comment": "Code looks wrong",
      "review_sub_reason": "BACKFILLED"
    }
  ],
  "jar_analysis_reviews": [
    {
      "reviewer_collaborator_alias": "string",
      "created_at_millis": 0,
      "review_state": "APPROVED",
      "comment": "Not ready to run yet",
      "review_sub_reason": "AUTO_APPROVED"
    }
  ],
  "notebook_review_state": "APPROVED",
  "jar_analysis_review_state": "APPROVED"
}

Create a review (e.g. approval) for an asset Beta

POST /api/2.0/clean-rooms/{clean_room_name}/assets/{asset_type}/{name}/reviews

Submit an asset review

API scopes: cleanrooms

Parameters

clean_room_namestringRequiredpath

Name of the clean room

asset_typestringRequiredpath

Asset type. Can either be NOTEBOOK_FILE or JAR_ANALYSIS.

Values:

• ASSET_TYPE_UNSPECIFIED
• TABLE
• NOTEBOOK_FILE
• VOLUME
• VIEW
• FOREIGN_TABLE
• JAR_ANALYSIS

namestringRequiredpath

Name of the asset

Request body

notebook_reviewobject

Show child attributesHide child attributes

etagstringRequired

Etag identifying the notebook version

review_statestringRequired

Review outcome

Values:

• NOTEBOOK_REVIEW_STATE_UNSPECIFIED
• APPROVED
• REJECTED
• PENDING

commentstring<= 500 characters

Review comment

Example: Code looks wrong

jar_analysis_reviewobject

Show child attributesHide child attributes

etagstringRequired

Etag identifying the jar analysis version, with its value being a hash of an internally-generated UUID

review_statestringRequired

Review outcome

Values:

• JAR_ANALYSIS_REVIEW_STATE_UNSPECIFIED
• APPROVED
• REJECTED
• PENDING

commentstring<= 500 characters

Review comment

Example: Code looks wrong

Response

Returns the CreateCleanRoomAssetReviewResponse object.

View as Markdown

Request

{
  "notebook_review": {
    "etag": "string",
    "review_state": "APPROVED",
    "comment": "Code looks wrong"
  },
  "jar_analysis_review": {
    "etag": "string",
    "review_state": "APPROVED",
    "comment": "Code looks wrong"
  }
}

Response

{
  "notebook_reviews": [
    {
      "reviewer_collaborator_alias": "string",
      "created_at_millis": 0,
      "review_state": "APPROVED",
      "comment": "Code looks wrong",
      "review_sub_reason": "BACKFILLED"
    }
  ],
  "jar_analysis_reviews": [
    {
      "reviewer_collaborator_alias": "string",
      "created_at_millis": 0,
      "review_state": "APPROVED",
      "comment": "Not ready to run yet",
      "review_sub_reason": "AUTO_APPROVED"
    }
  ],
  "notebook_review_state": "APPROVED",
  "jar_analysis_review_state": "APPROVED"
}