Skip to content

Conversation

@parthban-db
Copy link
Contributor

@parthban-db parthban-db commented Jan 24, 2025

What changes are proposed in this pull request?

This PR adds CI/CD environment to the User Agent of each SDK outbound request. The implementation is similar to the one used in the Go SDK. This is useful to track how often and from which CI/CD platforms our tools are being run.

How is this tested?

Added unit tests.

@parthban-db parthban-db changed the title [Internal] CICD provider [Internal] Add CICD environment to User Agent Jan 31, 2025
@github-actions
Copy link

If integration tests don't run automatically, an authorized user can run them manually by following the instructions below:

Trigger:
go/deco-tests-run/sdk-java

Inputs:

  • PR number: 404
  • Commit SHA: 5694c26bda90535d1473f8a53c296afc5160589c

Checks will be approved automatically on success.

@renaudhartert-db renaudhartert-db added this pull request to the merge queue Feb 3, 2025
Merged via the queue into main with commit 356837d Feb 3, 2025
15 checks passed
@renaudhartert-db renaudhartert-db deleted the parthban-db/cicd-provider branch February 3, 2025 13:35
mgyucht added a commit that referenced this pull request Feb 3, 2025
### Bug Fixes

 * Correctly include query parameters for APIs whose request objects contain the body as a field ([#401](#401)).

### Internal Changes

 * Add CICD environment to User Agent ([#404](#404)).

### API Changes:

 * Added `accountClient.budgetPolicy()` service.
 * Added `accountClient.enableIpAccessLists()` service.
 * Added `workspaceClient.accessControl()` service.
 * Added `workspaceClient.lakeviewEmbedded()` service and `workspaceClient.queryExecution()` service.
 * Added `workspaceClient.redashConfig()` service.
 * Added `httpRequest()` method for `workspaceClient.servingEndpoints()` service.
 * Added `gcpOauthToken` field for `com.databricks.sdk.service.catalog.TemporaryCredentials`.
 * Added `options` field for `com.databricks.sdk.service.catalog.UpdateCatalog`.
 * Added `reviewState`, `reviews` and `runnerCollaborators` fields for `com.databricks.sdk.service.cleanrooms.CleanRoomAssetNotebook`.
 * Added `statementId` field for `com.databricks.sdk.service.dashboards.QueryAttachment`.
 * Added `effectivePerformanceTarget` field for `com.databricks.sdk.service.jobs.BaseRun`.
 * Added `performanceTarget` field for `com.databricks.sdk.service.jobs.CreateJob`.
 * Added `performanceTarget` field for `com.databricks.sdk.service.jobs.JobSettings`.
 * Added `effectivePerformanceTarget` field for `com.databricks.sdk.service.jobs.Run`.
 * Added `performanceTarget` field for `com.databricks.sdk.service.jobs.RunNow`.
 * Added `cleanRoomsNotebookOutput` field for `com.databricks.sdk.service.jobs.RunOutput`.
 * Added `disabled` and `effectivePerformanceTarget` fields for `com.databricks.sdk.service.jobs.RunTask`.
 * Added `runAsRepl` field for `com.databricks.sdk.service.jobs.SparkJarTask`.
 * Added `userAuthorizedScopes` field for `com.databricks.sdk.service.oauth2.CreateCustomAppIntegration`.
 * Added `userAuthorizedScopes` field for `com.databricks.sdk.service.oauth2.GetCustomAppIntegrationOutput`.
 * Added `scopes` and `userAuthorizedScopes` fields for `com.databricks.sdk.service.oauth2.UpdateCustomAppIntegration`.
 * Added `contents` field for `com.databricks.sdk.service.serving.GetOpenApiResponse`.
 * Added `activated`, `activationUrl`, `authenticationType`, `cloud`, `comment`, `createdAt`, `createdBy`, `dataRecipientGlobalMetastoreId`, `ipAccessList`, `metastoreId`, `name`, `owner`, `propertiesKvpairs`, `region`, `sharingCode`, `tokens`, `updatedAt` and `updatedBy` fields for `com.databricks.sdk.service.sharing.RecipientInfo`.
 * Added `expirationTime` field for `com.databricks.sdk.service.sharing.RecipientInfo`.
 * Changed `update()` method for `workspaceClient.recipients()` service to return `com.databricks.sdk.service.sharing.RecipientInfo` class.
 * Changed `update()` method for `workspaceClient.recipients()` service to type `update()` method for `workspaceClient.recipients()` service.
 * Changed `update()` method for `workspaceClient.recipients()` service return type to become non-empty.
 * Changed `create()` method for `workspaceClient.servingEndpoints()` service with new required argument order.
 * Changed `getOpenApi()` method for `workspaceClient.servingEndpoints()` service return type to become non-empty.
 * Changed `patch()` method for `workspaceClient.servingEndpoints()` service to return `com.databricks.sdk.service.serving.EndpointTags` class.
 * Changed `patch()` method for `workspaceClient.servingEndpoints()` service to type `patch()` method for `workspaceClient.servingEndpoints()` service.
 * Changed `com.databricks.sdk.service.serving.EndpointTagList` class to.
 * Changed `collaboratorAlias` field for `com.databricks.sdk.service.cleanrooms.CleanRoomCollaborator` to be required.
 * Changed `collaboratorAlias` field for `com.databricks.sdk.service.cleanrooms.CleanRoomCollaborator` to be required.
 * Changed `behavior` field for `com.databricks.sdk.service.serving.AiGatewayGuardrailPiiBehavior` to no longer be required.
 * Changed `behavior` field for `com.databricks.sdk.service.serving.AiGatewayGuardrailPiiBehavior` to no longer be required.
 * Changed `config` field for `com.databricks.sdk.service.serving.CreateServingEndpoint` to no longer be required.
 * Changed `projectId` and `region` fields for `com.databricks.sdk.service.serving.GoogleCloudVertexAiConfig` to be required.
 * Changed `projectId` and `region` fields for `com.databricks.sdk.service.serving.GoogleCloudVertexAiConfig` to be required.
 * Changed `workloadType` field for `com.databricks.sdk.service.serving.ServedEntityInput` to type `com.databricks.sdk.service.serving.ServingModelWorkloadType` class.
 * Changed `workloadType` field for `com.databricks.sdk.service.serving.ServedEntityOutput` to type `com.databricks.sdk.service.serving.ServingModelWorkloadType` class.
 * Changed `workloadType` field for `com.databricks.sdk.service.serving.ServedModelOutput` to type `com.databricks.sdk.service.serving.ServingModelWorkloadType` class.
 * Removed `securableKind` field for `com.databricks.sdk.service.catalog.CatalogInfo`.
 * Removed `securableKind` field for `com.databricks.sdk.service.catalog.ConnectionInfo`.

OpenAPI SHA: c72c58f97b950fcb924a90ef164bcb10cfcd5ece, Date: 2025-02-03
@mgyucht mgyucht mentioned this pull request Feb 3, 2025
github-merge-queue bot pushed a commit that referenced this pull request Feb 3, 2025
### Bug Fixes

* Correctly include query parameters for APIs whose request objects
contain the body as a field
([#401](#401)).


### Internal Changes

* Add CICD environment to User Agent
([#404](#404)).


### API Changes:

 * Added `accountClient.budgetPolicy()` service.
 * Added `accountClient.enableIpAccessLists()` service.
 * Added `workspaceClient.accessControl()` service.
* Added `workspaceClient.lakeviewEmbedded()` service and
`workspaceClient.queryExecution()` service.
 * Added `workspaceClient.redashConfig()` service.
* Added `httpRequest()` method for `workspaceClient.servingEndpoints()`
service.
* Added `gcpOauthToken` field for
`com.databricks.sdk.service.catalog.TemporaryCredentials`.
* Added `options` field for
`com.databricks.sdk.service.catalog.UpdateCatalog`.
* Added `reviewState`, `reviews` and `runnerCollaborators` fields for
`com.databricks.sdk.service.cleanrooms.CleanRoomAssetNotebook`.
* Added `statementId` field for
`com.databricks.sdk.service.dashboards.QueryAttachment`.
* Added `effectivePerformanceTarget` field for
`com.databricks.sdk.service.jobs.BaseRun`.
* Added `performanceTarget` field for
`com.databricks.sdk.service.jobs.CreateJob`.
* Added `performanceTarget` field for
`com.databricks.sdk.service.jobs.JobSettings`.
* Added `effectivePerformanceTarget` field for
`com.databricks.sdk.service.jobs.Run`.
* Added `performanceTarget` field for
`com.databricks.sdk.service.jobs.RunNow`.
* Added `cleanRoomsNotebookOutput` field for
`com.databricks.sdk.service.jobs.RunOutput`.
* Added `disabled` and `effectivePerformanceTarget` fields for
`com.databricks.sdk.service.jobs.RunTask`.
* Added `runAsRepl` field for
`com.databricks.sdk.service.jobs.SparkJarTask`.
* Added `userAuthorizedScopes` field for
`com.databricks.sdk.service.oauth2.CreateCustomAppIntegration`.
* Added `userAuthorizedScopes` field for
`com.databricks.sdk.service.oauth2.GetCustomAppIntegrationOutput`.
* Added `scopes` and `userAuthorizedScopes` fields for
`com.databricks.sdk.service.oauth2.UpdateCustomAppIntegration`.
* Added `contents` field for
`com.databricks.sdk.service.serving.GetOpenApiResponse`.
* Added `activated`, `activationUrl`, `authenticationType`, `cloud`,
`comment`, `createdAt`, `createdBy`, `dataRecipientGlobalMetastoreId`,
`ipAccessList`, `metastoreId`, `name`, `owner`, `propertiesKvpairs`,
`region`, `sharingCode`, `tokens`, `updatedAt` and `updatedBy` fields
for `com.databricks.sdk.service.sharing.RecipientInfo`.
* Added `expirationTime` field for
`com.databricks.sdk.service.sharing.RecipientInfo`.
* Changed `update()` method for `workspaceClient.recipients()` service
to return `com.databricks.sdk.service.sharing.RecipientInfo` class.
* Changed `update()` method for `workspaceClient.recipients()` service
to type `update()` method for `workspaceClient.recipients()` service.
* Changed `update()` method for `workspaceClient.recipients()` service
return type to become non-empty.
* Changed `create()` method for `workspaceClient.servingEndpoints()`
service with new required argument order.
* Changed `getOpenApi()` method for `workspaceClient.servingEndpoints()`
service return type to become non-empty.
* Changed `patch()` method for `workspaceClient.servingEndpoints()`
service to return `com.databricks.sdk.service.serving.EndpointTags`
class.
* Changed `patch()` method for `workspaceClient.servingEndpoints()`
service to type `patch()` method for
`workspaceClient.servingEndpoints()` service.
* Changed `com.databricks.sdk.service.serving.EndpointTagList` class to.
* Changed `collaboratorAlias` field for
`com.databricks.sdk.service.cleanrooms.CleanRoomCollaborator` to be
required.
* Changed `collaboratorAlias` field for
`com.databricks.sdk.service.cleanrooms.CleanRoomCollaborator` to be
required.
* Changed `behavior` field for
`com.databricks.sdk.service.serving.AiGatewayGuardrailPiiBehavior` to no
longer be required.
* Changed `behavior` field for
`com.databricks.sdk.service.serving.AiGatewayGuardrailPiiBehavior` to no
longer be required.
* Changed `config` field for
`com.databricks.sdk.service.serving.CreateServingEndpoint` to no longer
be required.
* Changed `projectId` and `region` fields for
`com.databricks.sdk.service.serving.GoogleCloudVertexAiConfig` to be
required.
* Changed `projectId` and `region` fields for
`com.databricks.sdk.service.serving.GoogleCloudVertexAiConfig` to be
required.
* Changed `workloadType` field for
`com.databricks.sdk.service.serving.ServedEntityInput` to type
`com.databricks.sdk.service.serving.ServingModelWorkloadType` class.
* Changed `workloadType` field for
`com.databricks.sdk.service.serving.ServedEntityOutput` to type
`com.databricks.sdk.service.serving.ServingModelWorkloadType` class.
* Changed `workloadType` field for
`com.databricks.sdk.service.serving.ServedModelOutput` to type
`com.databricks.sdk.service.serving.ServingModelWorkloadType` class.
* Removed `securableKind` field for
`com.databricks.sdk.service.catalog.CatalogInfo`.
* Removed `securableKind` field for
`com.databricks.sdk.service.catalog.ConnectionInfo`.

OpenAPI SHA: c72c58f97b950fcb924a90ef164bcb10cfcd5ece, Date: 2025-02-03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants