Reference documentation and code samples for the Google Cloud Secure Source Manager V1 Client class Hook.
Metadata of a Secure Source Manager Hook.
Generated from protobuf message google.cloud.securesourcemanager.v1.Hook
Namespace
Google \ Cloud \ SecureSourceManager \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. A unique identifier for a Hook. The name should be of the format: |
↳ target_uri |
string
Required. The target URI to which the payloads will be delivered. |
↳ disabled |
bool
Optional. Determines if the hook disabled or not. Set to true to stop sending traffic. |
↳ events |
array
Optional. The events that trigger hook on. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Create timestamp. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Update timestamp. |
↳ uid |
string
Output only. Unique identifier of the hook. |
↳ push_option |
Hook\PushOption
Optional. The trigger option for push events. |
↳ sensitive_query_string |
string
Optional. The sensitive query string to be appended to the target URI. |
getName
Identifier. A unique identifier for a Hook. The name should be of the
format:
projects/{project}/locations/{location_id}/repositories/{repository_id}/hooks/{hook_id}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. A unique identifier for a Hook. The name should be of the
format:
projects/{project}/locations/{location_id}/repositories/{repository_id}/hooks/{hook_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTargetUri
Required. The target URI to which the payloads will be delivered.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTargetUri
Required. The target URI to which the payloads will be delivered.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisabled
Optional. Determines if the hook disabled or not.
Set to true to stop sending traffic.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setDisabled
Optional. Determines if the hook disabled or not.
Set to true to stop sending traffic.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEvents
Optional. The events that trigger hook on.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setEvents
Optional. The events that trigger hook on.
| Parameter | |
|---|---|
| Name | Description |
var |
int[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. Create timestamp.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Create timestamp.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. Update timestamp.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Update timestamp.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUid
Output only. Unique identifier of the hook.
| Returns | |
|---|---|
| Type | Description |
string |
|
setUid
Output only. Unique identifier of the hook.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPushOption
Optional. The trigger option for push events.
| Returns | |
|---|---|
| Type | Description |
Hook\PushOption|null |
|
hasPushOption
clearPushOption
setPushOption
Optional. The trigger option for push events.
| Parameter | |
|---|---|
| Name | Description |
var |
Hook\PushOption
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSensitiveQueryString
Optional. The sensitive query string to be appended to the target URI.
| Returns | |
|---|---|
| Type | Description |
string |
|
setSensitiveQueryString
Optional. The sensitive query string to be appended to the target URI.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|