Reference documentation and code samples for the Google Cloud Dataplex V1 Client class LookupEntryRequest.
Lookup Entry request using permissions in the source system.
Generated from protobuf message google.cloud.dataplex.v1.LookupEntryRequest
Namespace
Google \ Cloud \ Dataplex \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The project to which the request should be attributed in the following form: |
↳ view |
int
Optional. View to control which parts of an entry the service should return. Please check the limitations on returned aspects in the Entry view documentation. Amount of returned aspects depends on the selected Entry View. |
↳ aspect_types |
string[]
Optional. Limits the aspects returned to the provided aspect types. It only works for CUSTOM view. |
↳ paths |
string[]
Optional. Limits the aspects returned to those associated with the provided paths within the Entry. It only works for CUSTOM view. |
↳ entry |
string
Required. The resource name of the Entry: |
getName
Required. The project to which the request should be attributed in the
following form: projects/{project}/locations/{location}.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. The project to which the request should be attributed in the
following form: projects/{project}/locations/{location}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getView
Optional. View to control which parts of an entry the service should return.
Please check the limitations on returned aspects in the Entry view documentation. Amount of returned aspects depends on the selected Entry View.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type EntryView. |
setView
Optional. View to control which parts of an entry the service should return.
Please check the limitations on returned aspects in the Entry view documentation. Amount of returned aspects depends on the selected Entry View.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type EntryView. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAspectTypes
Optional. Limits the aspects returned to the provided aspect types.
It only works for CUSTOM view.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setAspectTypes
Optional. Limits the aspects returned to the provided aspect types.
It only works for CUSTOM view.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPaths
Optional. Limits the aspects returned to those associated with the provided paths within the Entry. It only works for CUSTOM view.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setPaths
Optional. Limits the aspects returned to those associated with the provided paths within the Entry. It only works for CUSTOM view.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEntry
Required. The resource name of the Entry:
projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
| Returns | |
|---|---|
| Type | Description |
string |
|
setEntry
Required. The resource name of the Entry:
projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|