Hook class

Hook is a user-defined HTTP callback triggered by an event.

To get more information about Hook, see:

How-to Guides
Official Documentation

Example Usage

Import

Hook can be imported using any of these accepted formats:

projects/{{project}}/locations/{{location}}/repositories/{{repository_id}}/hooks/{{hook_id}}
{{project}}/{{location}}/{{repository_id}}/{{hook_id}}
{{location}}/{{repository_id}}/{{hook_id}}
{{hook_id}}

When using the pulumi import command, Hook can be imported using one of the formats above. For example:

$ pulumi import gcp:securesourcemanager/hook:Hook default projects/{{project}}/locations/{{location}}/repositories/{{repository_id}}/hooks/{{hook_id}}
$ pulumi import gcp:securesourcemanager/hook:Hook default {{project}}/{{location}}/{{repository_id}}/{{hook_id}}
$ pulumi import gcp:securesourcemanager/hook:Hook default {{location}}/{{repository_id}}/{{hook_id}}
$ pulumi import gcp:securesourcemanager/hook:Hook default {{hook_id}}

Constructors

Hook(String name, {HookArgs? args, CustomResourceOptions? options}): Creates a new Hook. name The Pulumi resource name. args Arguments used to configure this Hook. The set of arguments for Hook. options Resource options controlling this resource's behavior.
Hook.reference(String urn): Creates a typed reference to an existing Hook resource.

Properties

childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
createTime ↔ Output<String>: Create timestamp.
latefinal
deletionPolicy ↔ Output<String>: Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
latefinal
disabled ↔ Output<bool?>: Determines if the hook disabled or not. Set to true to stop sending traffic.
latefinal
events ↔ Output<List<String>>: The events that trigger hook on. Each value may be one of: PUSH, PULL_REQUEST, PULL_REQUEST_COMMENT.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
hookId ↔ Output<String>: The ID for the Hook.
latefinal
id ↔ Output<String>: getter/setter pairinherited
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
location ↔ Output<String>: The location for the Repository.
latefinal
name ↔ Output<String>: A unique identifier for a Hook. The name should be of the format: projects/{project}/locations/{location_id}/repositories/{repository_id}/hooks/{hook_id}
latefinal
project ↔ Output<String>: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
latefinal
pushOption ↔ Output<HookPushOption>: The trigger option for push events. Structure is documented below.
latefinal
repositoryId ↔ Output<String>: The ID for the Repository.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
sensitiveQueryString ↔ Output<String?>: The sensitive query string to be appended to the target URI. Note: This property is sensitive and will not be displayed in the plan.
latefinal
targetUri ↔ Output<String>: The target URI to which the payloads will be delivered.
latefinal
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
uid ↔ Output<String>: Unique identifier of the hook.
latefinal
updateTime ↔ Output<String>: Update timestamp.
latefinal
urn ↔ Output<String>: latefinalinherited

Methods

failId(Object error) → void: Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void: Completes all output properties with error.
inherited
failUrn(Object error) → void: Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?: Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String: Returns this resource's logical name.
inherited
getResourceType() → String: Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>: Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void: Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void: Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void: Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>: Serializes resource properties for RPC transmission.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {HookState? state, CustomResourceOptions? options}) → Hook: Gets an existing Hook resource's state with the given name and id.