Reference documentation and code samples for the Google Cloud Dataplex V1 Client class ChangeRequest.
Represents a proposed change to a metadata resource.
Generated from protobuf message google.cloud.dataplex.v1.ChangeRequest
Namespace
Google \ Cloud \ Dataplex \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The relative resource name of the ChangeRequest, of the form: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id} |
↳ uid |
string
Output only. System generated globally unique ID for the ChangeRequest. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The time when the ChangeRequest was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The time when the ChangeRequest was last updated. |
↳ justification |
string
Optional. Justification of the ChangeRequest. This should explain why the change is needed or why it should be approved. |
↳ labels |
array|Google\Protobuf\Internal\MapField
Optional. User-defined labels for the ChangeRequest. |
↳ author |
string
Output only. The email address of the user who created the ChangeRequest. |
↳ state |
int
Output only. The current state of 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 |
↳ create_entry |
CreateEntryRequest
Payload for creating an Entry. |
↳ update_entry |
UpdateEntryRequest
Payload for updating an Entry. |
↳ delete_entry |
DeleteEntryRequest
Payload for deleting an Entry. |
↳ create_entry_link |
CreateEntryLinkRequest
Payload for creating an EntryLink. |
↳ delete_entry_link |
DeleteEntryLinkRequest
Payload for deleting an EntryLink. |
↳ create_glossary |
CreateGlossaryRequest
Payload for creating a Glossary. |
↳ update_glossary |
UpdateGlossaryRequest
Payload for updating a Glossary. |
↳ delete_glossary |
DeleteGlossaryRequest
Payload for deleting a Glossary. |
↳ create_glossary_category |
CreateGlossaryCategoryRequest
Payload for creating a GlossaryCategory. |
↳ update_glossary_category |
UpdateGlossaryCategoryRequest
Payload for updating a GlossaryCategory. |
↳ delete_glossary_category |
DeleteGlossaryCategoryRequest
Payload for deleting a GlossaryCategory. |
↳ create_glossary_term |
CreateGlossaryTermRequest
Payload for creating a GlossaryTerm. |
↳ update_glossary_term |
UpdateGlossaryTermRequest
Payload for updating a GlossaryTerm. |
↳ delete_glossary_term |
DeleteGlossaryTermRequest
Payload for deleting a GlossaryTerm. |
↳ data_product_access_request |
DataProductAccessRequest
Payload for Data Product access request. |
↳ change_type |
int
Output only. The type of change represented by the change_payload. This field is derived from the populated field in the change_payload oneof. |
↳ rejection_comment |
string
Output only. The reason provided for rejecting the ChangeRequest. |
↳ approver |
string
Output only. The email address of the user who approved/rejected the ChangeRequest. |
↳ 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. |
getName
Identifier. The relative resource name of the ChangeRequest, of the form: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The relative resource name of the ChangeRequest, of the form: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUid
Output only. System generated globally unique ID for the ChangeRequest.
| Returns | |
|---|---|
| Type | Description |
string |
|
setUid
Output only. System generated globally unique ID for the ChangeRequest.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. The time when the ChangeRequest was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time when the ChangeRequest was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The time when the ChangeRequest was last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time when the ChangeRequest was last updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getJustification
Optional. Justification of the ChangeRequest. This should explain why the change is needed or why it should be approved.
| Returns | |
|---|---|
| Type | Description |
string |
|
setJustification
Optional. Justification of the ChangeRequest. This should explain why the change is needed or why it should be approved.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
Optional. User-defined labels for the ChangeRequest.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
Optional. User-defined labels for the ChangeRequest.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAuthor
Output only. The email address of the user who created the ChangeRequest.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAuthor
Output only. The email address of the user who created the ChangeRequest.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. The current state of the ChangeRequest.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type State. |
setState
Output only. The current state of the ChangeRequest.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type State. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getResource
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
| Returns | |
|---|---|
| Type | Description |
string |
|
setResource
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
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateEntry
Payload for creating an Entry.
| Returns | |
|---|---|
| Type | Description |
CreateEntryRequest|null |
|
hasCreateEntry
setCreateEntry
Payload for creating an Entry.
| Parameter | |
|---|---|
| Name | Description |
var |
CreateEntryRequest
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateEntry
Payload for updating an Entry.
| Returns | |
|---|---|
| Type | Description |
UpdateEntryRequest|null |
|
hasUpdateEntry
setUpdateEntry
Payload for updating an Entry.
| Parameter | |
|---|---|
| Name | Description |
var |
UpdateEntryRequest
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeleteEntry
Payload for deleting an Entry.
| Returns | |
|---|---|
| Type | Description |
DeleteEntryRequest|null |
|
hasDeleteEntry
setDeleteEntry
Payload for deleting an Entry.
| Parameter | |
|---|---|
| Name | Description |
var |
DeleteEntryRequest
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateEntryLink
Payload for creating an EntryLink.
| Returns | |
|---|---|
| Type | Description |
CreateEntryLinkRequest|null |
|
hasCreateEntryLink
setCreateEntryLink
Payload for creating an EntryLink.
| Parameter | |
|---|---|
| Name | Description |
var |
CreateEntryLinkRequest
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeleteEntryLink
Payload for deleting an EntryLink.
| Returns | |
|---|---|
| Type | Description |
DeleteEntryLinkRequest|null |
|
hasDeleteEntryLink
setDeleteEntryLink
Payload for deleting an EntryLink.
| Parameter | |
|---|---|
| Name | Description |
var |
DeleteEntryLinkRequest
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateGlossary
Payload for creating a Glossary.
| Returns | |
|---|---|
| Type | Description |
CreateGlossaryRequest|null |
|
hasCreateGlossary
setCreateGlossary
Payload for creating a Glossary.
| Parameter | |
|---|---|
| Name | Description |
var |
CreateGlossaryRequest
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateGlossary
Payload for updating a Glossary.
| Returns | |
|---|---|
| Type | Description |
UpdateGlossaryRequest|null |
|
hasUpdateGlossary
setUpdateGlossary
Payload for updating a Glossary.
| Parameter | |
|---|---|
| Name | Description |
var |
UpdateGlossaryRequest
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeleteGlossary
Payload for deleting a Glossary.
| Returns | |
|---|---|
| Type | Description |
DeleteGlossaryRequest|null |
|
hasDeleteGlossary
setDeleteGlossary
Payload for deleting a Glossary.
| Parameter | |
|---|---|
| Name | Description |
var |
DeleteGlossaryRequest
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateGlossaryCategory
Payload for creating a GlossaryCategory.
| Returns | |
|---|---|
| Type | Description |
CreateGlossaryCategoryRequest|null |
|
hasCreateGlossaryCategory
setCreateGlossaryCategory
Payload for creating a GlossaryCategory.
| Parameter | |
|---|---|
| Name | Description |
var |
CreateGlossaryCategoryRequest
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateGlossaryCategory
Payload for updating a GlossaryCategory.
| Returns | |
|---|---|
| Type | Description |
UpdateGlossaryCategoryRequest|null |
|
hasUpdateGlossaryCategory
setUpdateGlossaryCategory
Payload for updating a GlossaryCategory.
| Parameter | |
|---|---|
| Name | Description |
var |
UpdateGlossaryCategoryRequest
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeleteGlossaryCategory
Payload for deleting a GlossaryCategory.
| Returns | |
|---|---|
| Type | Description |
DeleteGlossaryCategoryRequest|null |
|
hasDeleteGlossaryCategory
setDeleteGlossaryCategory
Payload for deleting a GlossaryCategory.
| Parameter | |
|---|---|
| Name | Description |
var |
DeleteGlossaryCategoryRequest
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateGlossaryTerm
Payload for creating a GlossaryTerm.
| Returns | |
|---|---|
| Type | Description |
CreateGlossaryTermRequest|null |
|
hasCreateGlossaryTerm
setCreateGlossaryTerm
Payload for creating a GlossaryTerm.
| Parameter | |
|---|---|
| Name | Description |
var |
CreateGlossaryTermRequest
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateGlossaryTerm
Payload for updating a GlossaryTerm.
| Returns | |
|---|---|
| Type | Description |
UpdateGlossaryTermRequest|null |
|
hasUpdateGlossaryTerm
setUpdateGlossaryTerm
Payload for updating a GlossaryTerm.
| Parameter | |
|---|---|
| Name | Description |
var |
UpdateGlossaryTermRequest
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeleteGlossaryTerm
Payload for deleting a GlossaryTerm.
| Returns | |
|---|---|
| Type | Description |
DeleteGlossaryTermRequest|null |
|
hasDeleteGlossaryTerm
setDeleteGlossaryTerm
Payload for deleting a GlossaryTerm.
| Parameter | |
|---|---|
| Name | Description |
var |
DeleteGlossaryTermRequest
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDataProductAccessRequest
Payload for Data Product access request.
| Returns | |
|---|---|
| Type | Description |
DataProductAccessRequest|null |
|
hasDataProductAccessRequest
setDataProductAccessRequest
Payload for Data Product access request.
| Parameter | |
|---|---|
| Name | Description |
var |
DataProductAccessRequest
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getChangeType
Output only. The type of change represented by the change_payload.
This field is derived from the populated field in the change_payload oneof.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type ChangeType. |
setChangeType
Output only. The type of change represented by the change_payload.
This field is derived from the populated field in the change_payload oneof.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type ChangeType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRejectionComment
Output only. The reason provided for rejecting the ChangeRequest.
| Returns | |
|---|---|
| Type | Description |
string |
|
setRejectionComment
Output only. The reason provided for rejecting the ChangeRequest.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getApprover
Output only. The email address of the user who approved/rejected the ChangeRequest.
| Returns | |
|---|---|
| Type | Description |
string |
|
setApprover
Output only. The email address of the user who approved/rejected the ChangeRequest.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEtag
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setEtag
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getChangePayload
| Returns | |
|---|---|
| Type | Description |
string |
|