Reference documentation and code samples for the Google Cloud Api Hub V1 Client class Curation.
A curation resource in the API Hub.
Generated from protobuf message google.cloud.apihub.v1.Curation
Namespace
Google \ Cloud \ ApiHub \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The name of the curation. Format: |
↳ display_name |
string
Required. The display name of the curation. |
↳ description |
string
Optional. The description of the curation. |
↳ endpoint |
Endpoint
Required. The endpoint to be triggered for curation. |
↳ plugin_instance_actions |
array<Curation\PluginInstanceActionID>
Output only. The plugin instances and associated actions that are using the curation. Note: A particular curation could be used by multiple plugin instances or multiple actions in a plugin instance. |
↳ last_execution_state |
int
Output only. The last execution state of the curation. |
↳ last_execution_error_code |
int
Output only. The error code of the last execution of the curation. The error code is populated only when the last execution state is failed. |
↳ last_execution_error_message |
string
Output only. Error message describing the failure, if any, during the last execution of the curation. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The time at which the curation was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The time at which the curation was last updated. |
getName
Identifier. The name of the curation.
Format:
projects/{project}/locations/{location}/curations/{curation}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The name of the curation.
Format:
projects/{project}/locations/{location}/curations/{curation}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Required. The display name of the curation.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Required. The display name of the curation.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. The description of the curation.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. The description of the curation.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndpoint
Required. The endpoint to be triggered for curation.
| Returns | |
|---|---|
| Type | Description |
Endpoint|null |
|
hasEndpoint
clearEndpoint
setEndpoint
Required. The endpoint to be triggered for curation.
| Parameter | |
|---|---|
| Name | Description |
var |
Endpoint
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPluginInstanceActions
Output only. The plugin instances and associated actions that are using the curation. Note: A particular curation could be used by multiple plugin instances or multiple actions in a plugin instance.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setPluginInstanceActions
Output only. The plugin instances and associated actions that are using the curation. Note: A particular curation could be used by multiple plugin instances or multiple actions in a plugin instance.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Curation\PluginInstanceActionID>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLastExecutionState
Output only. The last execution state of the curation.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type LastExecutionState. |
setLastExecutionState
Output only. The last execution state of the curation.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type LastExecutionState. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLastExecutionErrorCode
Output only. The error code of the last execution of the curation. The error code is populated only when the last execution state is failed.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type ErrorCode. |
setLastExecutionErrorCode
Output only. The error code of the last execution of the curation. The error code is populated only when the last execution state is failed.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type ErrorCode. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLastExecutionErrorMessage
Output only. Error message describing the failure, if any, during the last execution of the curation.
| Returns | |
|---|---|
| Type | Description |
string |
|
setLastExecutionErrorMessage
Output only. Error message describing the failure, if any, during the last execution of the curation.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. The time at which the curation was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time at which the curation was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The time at which the curation was last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time at which the curation was last updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|