Class Hook (0.40.0)

public final class Hook extends GeneratedMessageV3 implements HookOrBuilder

Metadata of a Secure Source Manager Hook.

Protobuf type google.cloud.securesourcemanager.v1.Hook

Implements

HookOrBuilder

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DISABLED_FIELD_NUMBER

public static final int DISABLED_FIELD_NUMBER
Field Value
Type Description
int

EVENTS_FIELD_NUMBER

public static final int EVENTS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PUSH_OPTION_FIELD_NUMBER

public static final int PUSH_OPTION_FIELD_NUMBER
Field Value
Type Description
int

SENSITIVE_QUERY_STRING_FIELD_NUMBER

public static final int SENSITIVE_QUERY_STRING_FIELD_NUMBER
Field Value
Type Description
int

TARGET_URI_FIELD_NUMBER

public static final int TARGET_URI_FIELD_NUMBER
Field Value
Type Description
int

UID_FIELD_NUMBER

public static final int UID_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Hook getDefaultInstance()
Returns
Type Description
Hook

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Hook.Builder newBuilder()
Returns
Type Description
Hook.Builder

newBuilder(Hook prototype)

public static Hook.Builder newBuilder(Hook prototype)
Parameter
Name Description
prototype Hook
Returns
Type Description
Hook.Builder

parseDelimitedFrom(InputStream input)

public static Hook parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Hook
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Hook parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Hook
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Hook parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Hook
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Hook parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Hook
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Hook parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Hook
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Hook parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Hook
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Hook parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Hook
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Hook parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Hook
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Hook parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Hook
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Hook parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Hook
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Hook parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Hook
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Hook parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Hook
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Hook> parser()
Returns
Type Description
Parser<Hook>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. Create timestamp.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Create timestamp.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Hook getDefaultInstanceForType()
Returns
Type Description
Hook

getDisabled()

public boolean getDisabled()

Optional. Determines if the hook disabled or not. Set to true to stop sending traffic.

bool disabled = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The disabled.

getEvents(int index)

public Hook.HookEventType getEvents(int index)

Optional. The events that trigger hook on.

repeated .google.cloud.securesourcemanager.v1.Hook.HookEventType events = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
Hook.HookEventType

The events at the given index.

getEventsCount()

public int getEventsCount()

Optional. The events that trigger hook on.

repeated .google.cloud.securesourcemanager.v1.Hook.HookEventType events = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of events.

getEventsList()

public List<Hook.HookEventType> getEventsList()

Optional. The events that trigger hook on.

repeated .google.cloud.securesourcemanager.v1.Hook.HookEventType events = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<HookEventType>

A list containing the events.

getEventsValue(int index)

public int getEventsValue(int index)

Optional. The events that trigger hook on.

repeated .google.cloud.securesourcemanager.v1.Hook.HookEventType events = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of events at the given index.

getEventsValueList()

public List<Integer> getEventsValueList()

Optional. The events that trigger hook on.

repeated .google.cloud.securesourcemanager.v1.Hook.HookEventType events = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for events.

getName()

public String 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}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Hook> getParserForType()
Returns
Type Description
Parser<Hook>
Overrides

getPushOption()

public Hook.PushOption getPushOption()

Optional. The trigger option for push events.

.google.cloud.securesourcemanager.v1.Hook.PushOption push_option = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Hook.PushOption

The pushOption.

getPushOptionOrBuilder()

public Hook.PushOptionOrBuilder getPushOptionOrBuilder()

Optional. The trigger option for push events.

.google.cloud.securesourcemanager.v1.Hook.PushOption push_option = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Hook.PushOptionOrBuilder

getSensitiveQueryString()

public String getSensitiveQueryString()

Optional. The sensitive query string to be appended to the target URI.

string sensitive_query_string = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The sensitiveQueryString.

getSensitiveQueryStringBytes()

public ByteString getSensitiveQueryStringBytes()

Optional. The sensitive query string to be appended to the target URI.

string sensitive_query_string = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for sensitiveQueryString.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTargetUri()

public String getTargetUri()

Required. The target URI to which the payloads will be delivered.

string target_uri = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The targetUri.

getTargetUriBytes()

public ByteString getTargetUriBytes()

Required. The target URI to which the payloads will be delivered.

string target_uri = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for targetUri.

getUid()

public String getUid()

Output only. Unique identifier of the hook.

string uid = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. Unique identifier of the hook.

string uid = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for uid.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Update timestamp.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Update timestamp.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Create timestamp.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasPushOption()

public boolean hasPushOption()

Optional. The trigger option for push events.

.google.cloud.securesourcemanager.v1.Hook.PushOption push_option = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the pushOption field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Update timestamp.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Hook.Builder newBuilderForType()
Returns
Type Description
Hook.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Hook.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Hook.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Hook.Builder toBuilder()
Returns
Type Description
Hook.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException