change_requests

Creates, updates, deletes, gets or lists a change_requests resource.

Overview

Name	change_requests
Type	Resource
Id	google.dataplex.change_requests

Fields

The following fields are returned by SELECT queries:

projects_locations_change_requests_get

Name	Datatype	Description
name	string	Identifier. The relative resource name of the ChangeRequest, of the form: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id}
approver	string	Output only. The email address of the user who approved/rejected the ChangeRequest.
author	string	Output only. The email address of the user who created the ChangeRequest.
changeType	string	Output only. The type of change represented by the change_payload. This field is derived from the populated field in the change_payload oneof. (CHANGE_TYPE_UNSPECIFIED, CREATE_ENTRY, UPDATE_ENTRY, DELETE_ENTRY, CREATE_ENTRY_LINK, DELETE_ENTRY_LINK, CREATE_GLOSSARY, UPDATE_GLOSSARY, DELETE_GLOSSARY, CREATE_GLOSSARY_CATEGORY, UPDATE_GLOSSARY_CATEGORY, DELETE_GLOSSARY_CATEGORY, CREATE_GLOSSARY_TERM, UPDATE_GLOSSARY_TERM, DELETE_GLOSSARY_TERM, REQUEST_DATA_PRODUCT_ACCESS)
createEntry	object	Payload for creating an Entry. (id: GoogleCloudDataplexV1CreateEntryRequest)
createEntryLink	object	Payload for creating an EntryLink. (id: GoogleCloudDataplexV1CreateEntryLinkRequest)
createGlossary	object	Payload for creating a Glossary. (id: GoogleCloudDataplexV1CreateGlossaryRequest)
createGlossaryCategory	object	Payload for creating a GlossaryCategory. (id: GoogleCloudDataplexV1CreateGlossaryCategoryRequest)
createGlossaryTerm	object	Payload for creating a GlossaryTerm. (id: GoogleCloudDataplexV1CreateGlossaryTermRequest)
createTime	string (google-datetime)	Output only. The time when the ChangeRequest was created.
dataProductAccessRequest	object	Payload for Data Product access request. (id: GoogleCloudDataplexV1DataProductAccessRequest)
deleteEntry	object	Payload for deleting an Entry. (id: GoogleCloudDataplexV1DeleteEntryRequest)
deleteEntryLink	object	Payload for deleting an EntryLink. (id: GoogleCloudDataplexV1DeleteEntryLinkRequest)
deleteGlossary	object	Payload for deleting a Glossary. (id: GoogleCloudDataplexV1DeleteGlossaryRequest)
deleteGlossaryCategory	object	Payload for deleting a GlossaryCategory. (id: GoogleCloudDataplexV1DeleteGlossaryCategoryRequest)
deleteGlossaryTerm	object	Payload for deleting a GlossaryTerm. (id: GoogleCloudDataplexV1DeleteGlossaryTermRequest)
etag	string	Optional. This checksum is computed by the service. It can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
justification	string	Optional. Justification of the ChangeRequest. This should explain why the change is needed or why it should be approved.
labels	object	Optional. User-defined labels for the ChangeRequest.
rejectionComment	string	Output only. The reason provided for rejecting the ChangeRequest.
resource	string	Output only. The full resource name of the target resource to be modified. Example: //dataplex.googleapis.com/projects/my-project/locations/us-central1/entryGroups/my-group/entries/my-entry
state	string	Output only. The current state of the ChangeRequest. (STATE_UNSPECIFIED, NEW, APPROVED, REJECTED, EXPIRED, REVOKED)
uid	string	Output only. System generated globally unique ID for the ChangeRequest.
updateEntry	object	Payload for updating an Entry. (id: GoogleCloudDataplexV1UpdateEntryRequest)
updateGlossary	object	Payload for updating a Glossary. (id: GoogleCloudDataplexV1UpdateGlossaryRequest)
updateGlossaryCategory	object	Payload for updating a GlossaryCategory. (id: GoogleCloudDataplexV1UpdateGlossaryCategoryRequest)
updateGlossaryTerm	object	Payload for updating a GlossaryTerm. (id: GoogleCloudDataplexV1UpdateGlossaryTermRequest)
updateTime	string (google-datetime)	Output only. The time when the ChangeRequest was last updated.

projects_locations_change_requests_list

Name	Datatype	Description
name	string	Identifier. The relative resource name of the ChangeRequest, of the form: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id}
approver	string	Output only. The email address of the user who approved/rejected the ChangeRequest.
author	string	Output only. The email address of the user who created the ChangeRequest.
changeType	string	Output only. The type of change represented by the change_payload. This field is derived from the populated field in the change_payload oneof. (CHANGE_TYPE_UNSPECIFIED, CREATE_ENTRY, UPDATE_ENTRY, DELETE_ENTRY, CREATE_ENTRY_LINK, DELETE_ENTRY_LINK, CREATE_GLOSSARY, UPDATE_GLOSSARY, DELETE_GLOSSARY, CREATE_GLOSSARY_CATEGORY, UPDATE_GLOSSARY_CATEGORY, DELETE_GLOSSARY_CATEGORY, CREATE_GLOSSARY_TERM, UPDATE_GLOSSARY_TERM, DELETE_GLOSSARY_TERM, REQUEST_DATA_PRODUCT_ACCESS)
createEntry	object	Payload for creating an Entry. (id: GoogleCloudDataplexV1CreateEntryRequest)
createEntryLink	object	Payload for creating an EntryLink. (id: GoogleCloudDataplexV1CreateEntryLinkRequest)
createGlossary	object	Payload for creating a Glossary. (id: GoogleCloudDataplexV1CreateGlossaryRequest)
createGlossaryCategory	object	Payload for creating a GlossaryCategory. (id: GoogleCloudDataplexV1CreateGlossaryCategoryRequest)
createGlossaryTerm	object	Payload for creating a GlossaryTerm. (id: GoogleCloudDataplexV1CreateGlossaryTermRequest)
createTime	string (google-datetime)	Output only. The time when the ChangeRequest was created.
dataProductAccessRequest	object	Payload for Data Product access request. (id: GoogleCloudDataplexV1DataProductAccessRequest)
deleteEntry	object	Payload for deleting an Entry. (id: GoogleCloudDataplexV1DeleteEntryRequest)
deleteEntryLink	object	Payload for deleting an EntryLink. (id: GoogleCloudDataplexV1DeleteEntryLinkRequest)
deleteGlossary	object	Payload for deleting a Glossary. (id: GoogleCloudDataplexV1DeleteGlossaryRequest)
deleteGlossaryCategory	object	Payload for deleting a GlossaryCategory. (id: GoogleCloudDataplexV1DeleteGlossaryCategoryRequest)
deleteGlossaryTerm	object	Payload for deleting a GlossaryTerm. (id: GoogleCloudDataplexV1DeleteGlossaryTermRequest)
etag	string	Optional. This checksum is computed by the service. It can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
justification	string	Optional. Justification of the ChangeRequest. This should explain why the change is needed or why it should be approved.
labels	object	Optional. User-defined labels for the ChangeRequest.
rejectionComment	string	Output only. The reason provided for rejecting the ChangeRequest.
resource	string	Output only. The full resource name of the target resource to be modified. Example: //dataplex.googleapis.com/projects/my-project/locations/us-central1/entryGroups/my-group/entries/my-entry
state	string	Output only. The current state of the ChangeRequest. (STATE_UNSPECIFIED, NEW, APPROVED, REJECTED, EXPIRED, REVOKED)
uid	string	Output only. System generated globally unique ID for the ChangeRequest.
updateEntry	object	Payload for updating an Entry. (id: GoogleCloudDataplexV1UpdateEntryRequest)
updateGlossary	object	Payload for updating a Glossary. (id: GoogleCloudDataplexV1UpdateGlossaryRequest)
updateGlossaryCategory	object	Payload for updating a GlossaryCategory. (id: GoogleCloudDataplexV1UpdateGlossaryCategoryRequest)
updateGlossaryTerm	object	Payload for updating a GlossaryTerm. (id: GoogleCloudDataplexV1UpdateGlossaryTermRequest)
updateTime	string (google-datetime)	Output only. The time when the ChangeRequest was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_change_requests_get	select	projectsId, locationsId, changeRequestsId		Gets a ChangeRequest.
projects_locations_change_requests_list	select	projectsId, locationsId	pageToken, filter, pageSize, orderBy	Lists ChangeRequests.
projects_locations_change_requests_patch	update	projectsId, locationsId, changeRequestsId	updateMask	Updates a ChangeRequest. Only allowed when the state is NEW.
projects_locations_change_requests_delete	delete	projectsId, locationsId, changeRequestsId	etag	Deletes a ChangeRequest.Behavior depends on the caller's permissions and the resource's state: 1. Callers with dataplex.changeRequests.delete can only delete ChangeRequests in the NEW state. 2. Callers with the dataplex.changeRequests.adminDelete permission can delete ChangeRequests regardless of their state.
projects_locations_change_requests_reject	exec	projectsId, locationsId, changeRequestsId		Rejects a ChangeRequest.
projects_locations_change_requests_approve	exec	projectsId, locationsId, changeRequestsId		Approves a ChangeRequest.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
changeRequestsId	string
locationsId	string
projectsId	string
etag	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_change_requests_get

Gets a ChangeRequest.

SELECT
name,
approver,
author,
changeType,
createEntry,
createEntryLink,
createGlossary,
createGlossaryCategory,
createGlossaryTerm,
createTime,
dataProductAccessRequest,
deleteEntry,
deleteEntryLink,
deleteGlossary,
deleteGlossaryCategory,
deleteGlossaryTerm,
etag,
justification,
labels,
rejectionComment,
resource,
state,
uid,
updateEntry,
updateGlossary,
updateGlossaryCategory,
updateGlossaryTerm,
updateTime
FROM google.dataplex.change_requests
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND changeRequestsId = '{{ changeRequestsId }}' -- required
;

projects_locations_change_requests_list

Lists ChangeRequests.

SELECT
name,
approver,
author,
changeType,
createEntry,
createEntryLink,
createGlossary,
createGlossaryCategory,
createGlossaryTerm,
createTime,
dataProductAccessRequest,
deleteEntry,
deleteEntryLink,
deleteGlossary,
deleteGlossaryCategory,
deleteGlossaryTerm,
etag,
justification,
labels,
rejectionComment,
resource,
state,
uid,
updateEntry,
updateGlossary,
updateGlossaryCategory,
updateGlossaryTerm,
updateTime
FROM google.dataplex.change_requests
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
;

UPDATE examples

projects_locations_change_requests_patch

Updates a ChangeRequest. Only allowed when the state is NEW.

UPDATE google.dataplex.change_requests
SET 
data__createGlossary = '{{ createGlossary }}',
data__updateEntry = '{{ updateEntry }}',
data__updateGlossary = '{{ updateGlossary }}',
data__deleteGlossary = '{{ deleteGlossary }}',
data__createGlossaryTerm = '{{ createGlossaryTerm }}',
data__dataProductAccessRequest = '{{ dataProductAccessRequest }}',
data__createGlossaryCategory = '{{ createGlossaryCategory }}',
data__justification = '{{ justification }}',
data__createEntry = '{{ createEntry }}',
data__deleteEntryLink = '{{ deleteEntryLink }}',
data__etag = '{{ etag }}',
data__createEntryLink = '{{ createEntryLink }}',
data__deleteGlossaryCategory = '{{ deleteGlossaryCategory }}',
data__labels = '{{ labels }}',
data__name = '{{ name }}',
data__updateGlossaryCategory = '{{ updateGlossaryCategory }}',
data__updateGlossaryTerm = '{{ updateGlossaryTerm }}',
data__deleteGlossaryTerm = '{{ deleteGlossaryTerm }}',
data__deleteEntry = '{{ deleteEntry }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND changeRequestsId = '{{ changeRequestsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
approver,
author,
changeType,
createEntry,
createEntryLink,
createGlossary,
createGlossaryCategory,
createGlossaryTerm,
createTime,
dataProductAccessRequest,
deleteEntry,
deleteEntryLink,
deleteGlossary,
deleteGlossaryCategory,
deleteGlossaryTerm,
etag,
justification,
labels,
rejectionComment,
resource,
state,
uid,
updateEntry,
updateGlossary,
updateGlossaryCategory,
updateGlossaryTerm,
updateTime;

DELETE examples

projects_locations_change_requests_delete

Deletes a ChangeRequest.Behavior depends on the caller's permissions and the resource's state: 1. Callers with dataplex.changeRequests.delete can only delete ChangeRequests in the NEW state. 2. Callers with the dataplex.changeRequests.adminDelete permission can delete ChangeRequests regardless of their state.

DELETE FROM google.dataplex.change_requests
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND changeRequestsId = '{{ changeRequestsId }}' --required
AND etag = '{{ etag }}'
;

Lifecycle Methods

projects_locations_change_requests_reject

Rejects a ChangeRequest.

EXEC google.dataplex.change_requests.projects_locations_change_requests_reject 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@changeRequestsId='{{ changeRequestsId }}' --required 
@@json=
'{
"comment": "{{ comment }}", 
"etag": "{{ etag }}"
}'
;

projects_locations_change_requests_approve

Approves a ChangeRequest.

EXEC google.dataplex.change_requests.projects_locations_change_requests_approve 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@changeRequestsId='{{ changeRequestsId }}' --required 
@@json=
'{
"etag": "{{ etag }}"
}'
;