Class JobTrigger (3.45.0)

public final class JobTrigger extends GeneratedMessageV3 implements JobTriggerOrBuilder

Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.

Protobuf type google.privacy.dlp.v2.JobTrigger

Implements

JobTriggerOrBuilder

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

ERRORS_FIELD_NUMBER

public static final int ERRORS_FIELD_NUMBER
Field Value
TypeDescription
int

INSPECT_JOB_FIELD_NUMBER

public static final int INSPECT_JOB_FIELD_NUMBER
Field Value
TypeDescription
int

LAST_RUN_TIME_FIELD_NUMBER

public static final int LAST_RUN_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
TypeDescription
int

TRIGGERS_FIELD_NUMBER

public static final int TRIGGERS_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static JobTrigger getDefaultInstance()
Returns
TypeDescription
JobTrigger

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static JobTrigger.Builder newBuilder()
Returns
TypeDescription
JobTrigger.Builder

newBuilder(JobTrigger prototype)

public static JobTrigger.Builder newBuilder(JobTrigger prototype)
Parameter
NameDescription
prototypeJobTrigger
Returns
TypeDescription
JobTrigger.Builder

parseDelimitedFrom(InputStream input)

public static JobTrigger parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
JobTrigger
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static JobTrigger parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
JobTrigger
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static JobTrigger parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
JobTrigger
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static JobTrigger parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
JobTrigger
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static JobTrigger parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
JobTrigger
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static JobTrigger parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
JobTrigger
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static JobTrigger parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
JobTrigger
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static JobTrigger parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
JobTrigger
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static JobTrigger parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
JobTrigger
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static JobTrigger parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
JobTrigger
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static JobTrigger parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
JobTrigger
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static JobTrigger parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
JobTrigger
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<JobTrigger> parser()
Returns
TypeDescription
Parser<JobTrigger>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. The creation timestamp of a triggeredJob.

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

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The creation timestamp of a triggeredJob.

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

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public JobTrigger getDefaultInstanceForType()
Returns
TypeDescription
JobTrigger

getDescription()

public String getDescription()

User provided description (max 256 chars)

string description = 3;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

User provided description (max 256 chars)

string description = 3;

Returns
TypeDescription
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

Display name (max 100 chars)

string display_name = 2;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Display name (max 100 chars)

string display_name = 2;

Returns
TypeDescription
ByteString

The bytes for displayName.

getErrors(int index)

public Error getErrors(int index)

Output only. A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automatically being paused. Will return the last 100 errors. Whenever the JobTrigger is modified this list will be cleared.

repeated .google.privacy.dlp.v2.Error errors = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
Error

getErrorsCount()

public int getErrorsCount()

Output only. A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automatically being paused. Will return the last 100 errors. Whenever the JobTrigger is modified this list will be cleared.

repeated .google.privacy.dlp.v2.Error errors = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

getErrorsList()

public List<Error> getErrorsList()

Output only. A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automatically being paused. Will return the last 100 errors. Whenever the JobTrigger is modified this list will be cleared.

repeated .google.privacy.dlp.v2.Error errors = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<Error>

getErrorsOrBuilder(int index)

public ErrorOrBuilder getErrorsOrBuilder(int index)

Output only. A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automatically being paused. Will return the last 100 errors. Whenever the JobTrigger is modified this list will be cleared.

repeated .google.privacy.dlp.v2.Error errors = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
ErrorOrBuilder

getErrorsOrBuilderList()

public List<? extends ErrorOrBuilder> getErrorsOrBuilderList()

Output only. A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automatically being paused. Will return the last 100 errors. Whenever the JobTrigger is modified this list will be cleared.

repeated .google.privacy.dlp.v2.Error errors = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<? extends com.google.privacy.dlp.v2.ErrorOrBuilder>

getInspectJob()

public InspectJobConfig getInspectJob()

For inspect jobs, a snapshot of the configuration.

.google.privacy.dlp.v2.InspectJobConfig inspect_job = 4;

Returns
TypeDescription
InspectJobConfig

The inspectJob.

getInspectJobOrBuilder()

public InspectJobConfigOrBuilder getInspectJobOrBuilder()

For inspect jobs, a snapshot of the configuration.

.google.privacy.dlp.v2.InspectJobConfig inspect_job = 4;

Returns
TypeDescription
InspectJobConfigOrBuilder

getJobCase()

public JobTrigger.JobCase getJobCase()
Returns
TypeDescription
JobTrigger.JobCase

getLastRunTime()

public Timestamp getLastRunTime()

Output only. The timestamp of the last time this trigger executed.

.google.protobuf.Timestamp last_run_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The lastRunTime.

getLastRunTimeOrBuilder()

public TimestampOrBuilder getLastRunTimeOrBuilder()

Output only. The timestamp of the last time this trigger executed.

.google.protobuf.Timestamp last_run_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getName()

public String getName()

Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example projects/dlp-test-project/jobTriggers/53234423.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example projects/dlp-test-project/jobTriggers/53234423.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<JobTrigger> getParserForType()
Returns
TypeDescription
Parser<JobTrigger>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStatus()

public JobTrigger.Status getStatus()

Required. A status for this trigger.

.google.privacy.dlp.v2.JobTrigger.Status status = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
JobTrigger.Status

The status.

getStatusValue()

public int getStatusValue()

Required. A status for this trigger.

.google.privacy.dlp.v2.JobTrigger.Status status = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

The enum numeric value on the wire for status.

getTriggers(int index)

public JobTrigger.Trigger getTriggers(int index)

A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object.

repeated .google.privacy.dlp.v2.JobTrigger.Trigger triggers = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
JobTrigger.Trigger

getTriggersCount()

public int getTriggersCount()

A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object.

repeated .google.privacy.dlp.v2.JobTrigger.Trigger triggers = 5;

Returns
TypeDescription
int

getTriggersList()

public List<JobTrigger.Trigger> getTriggersList()

A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object.

repeated .google.privacy.dlp.v2.JobTrigger.Trigger triggers = 5;

Returns
TypeDescription
List<Trigger>

getTriggersOrBuilder(int index)

public JobTrigger.TriggerOrBuilder getTriggersOrBuilder(int index)

A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object.

repeated .google.privacy.dlp.v2.JobTrigger.Trigger triggers = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
JobTrigger.TriggerOrBuilder

getTriggersOrBuilderList()

public List<? extends JobTrigger.TriggerOrBuilder> getTriggersOrBuilderList()

A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object.

repeated .google.privacy.dlp.v2.JobTrigger.Trigger triggers = 5;

Returns
TypeDescription
List<? extends com.google.privacy.dlp.v2.JobTrigger.TriggerOrBuilder>

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The last update timestamp of a triggeredJob.

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

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The last update timestamp of a triggeredJob.

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

Returns
TypeDescription
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The creation timestamp of a triggeredJob.

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

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasInspectJob()

public boolean hasInspectJob()

For inspect jobs, a snapshot of the configuration.

.google.privacy.dlp.v2.InspectJobConfig inspect_job = 4;

Returns
TypeDescription
boolean

Whether the inspectJob field is set.

hasLastRunTime()

public boolean hasLastRunTime()

Output only. The timestamp of the last time this trigger executed.

.google.protobuf.Timestamp last_run_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the lastRunTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The last update timestamp of a triggeredJob.

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

Returns
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public JobTrigger.Builder newBuilderForType()
Returns
TypeDescription
JobTrigger.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected JobTrigger.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
JobTrigger.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public JobTrigger.Builder toBuilder()
Returns
TypeDescription
JobTrigger.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException