Google Cloud Dataplex V1 Client - Class LookupContextRequest (1.14.0)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class LookupContextRequest.

Lookup Context using permissions in the source system.

Generated from protobuf message google.cloud.dataplex.v1.LookupContextRequest

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__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: projects/{project}/locations/{location}.
↳ resources string[]

Required. The entry names to look up the context for. The maximum number of resources for a request is limited to 10. ## Examples: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}
↳ context string

Optional. The text representing contextual information for which metadata context is being requested.
↳ options array|Google\Protobuf\Internal\MapField

Optional. Allows to configure the context. Supported options: - format - The format of the context (one of yaml, xml, json, default is yaml). - context_budget - If provided, the output will be intelligently truncated on a best-effort basis to contain approximately the desired amount of characters. There is no guarantee to achieve the specific amount.

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

getResources

Required. The entry names to look up the context for. The maximum number of resources for a request is limited to 10.

Examples:

projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}

Returns
Type Description
Google\Protobuf\RepeatedField<string>

setResources

Required. The entry names to look up the context for. The maximum number of resources for a request is limited to 10.

Examples:

projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}

Parameter
Name Description
var string[]
Returns
Type Description
$this

getContext

Optional. The text representing contextual information for which metadata context is being requested.

Returns
Type Description
string

setContext

Optional. The text representing contextual information for which metadata context is being requested.

Parameter
Name Description
var string
Returns
Type Description
$this

getOptions

Optional. Allows to configure the context.

Supported options:

  • format - The format of the context (one of yaml, xml, json, default is yaml).
  • context_budget - If provided, the output will be intelligently truncated on a best-effort basis to contain approximately the desired amount of characters. There is no guarantee to achieve the specific amount.
Returns
Type Description
Google\Protobuf\Internal\MapField

setOptions

Optional. Allows to configure the context.

Supported options:

  • format - The format of the context (one of yaml, xml, json, default is yaml).
  • context_budget - If provided, the output will be intelligently truncated on a best-effort basis to contain approximately the desired amount of characters. There is no guarantee to achieve the specific amount.
Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this