Class RuleDeployment (0.1.0) 

public final class RuleDeployment extends GeneratedMessageV3 implements RuleDeploymentOrBuilder

The RuleDeployment resource represents the deployment state of a Rule.

Protobuf type google.cloud.chronicle.v1.RuleDeployment

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > RuleDeployment

Static Fields

ALERTING_FIELD_NUMBER

public static final int ALERTING_FIELD_NUMBER
Field Value
Type Description
int

ARCHIVED_FIELD_NUMBER

public static final int ARCHIVED_FIELD_NUMBER
Field Value
Type Description
int

ARCHIVE_TIME_FIELD_NUMBER

public static final int ARCHIVE_TIME_FIELD_NUMBER
Field Value
Type Description
int

CONSUMER_RULES_FIELD_NUMBER

public static final int CONSUMER_RULES_FIELD_NUMBER
Field Value
Type Description
int

ENABLED_FIELD_NUMBER

public static final int ENABLED_FIELD_NUMBER
Field Value
Type Description
int

EXECUTION_STATE_FIELD_NUMBER

public static final int EXECUTION_STATE_FIELD_NUMBER
Field Value
Type Description
int

LAST_ALERT_STATUS_CHANGE_TIME_FIELD_NUMBER

public static final int LAST_ALERT_STATUS_CHANGE_TIME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PRODUCER_RULES_FIELD_NUMBER

public static final int PRODUCER_RULES_FIELD_NUMBER
Field Value
Type Description
int

RUN_FREQUENCY_FIELD_NUMBER

public static final int RUN_FREQUENCY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RuleDeployment getDefaultInstance()
Returns
Type Description
RuleDeployment

getDescriptor()

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

newBuilder()

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

newBuilder(RuleDeployment prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAlerting()

public boolean getAlerting()

Whether detections resulting from this deployment should be considered alerts.

bool alerting = 3;

Returns
Type Description
boolean

The alerting.

getArchiveTime()

public Timestamp getArchiveTime()

Output only. The timestamp when the rule deployment archive state was last set to true. If the rule deployment's current archive state is not set to true, the field will be empty.

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

Returns
Type Description
Timestamp

The archiveTime.

getArchiveTimeOrBuilder()

public TimestampOrBuilder getArchiveTimeOrBuilder()

Output only. The timestamp when the rule deployment archive state was last set to true. If the rule deployment's current archive state is not set to true, the field will be empty.

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

Returns
Type Description
TimestampOrBuilder

getArchived()

public boolean getArchived()

The archive state of the rule deployment. Cannot be set to true unless enabled is set to false. If set to true, alerting will automatically be set to false. If currently set to true, enabled, alerting, and run_frequency cannot be updated.

bool archived = 4;

Returns
Type Description
boolean

The archived.

getConsumerRules(int index)

public String getConsumerRules(int index)

Output only. The names of the associated/chained consumer rules. Rules are considered consumers of this rule if their rule text explicitly filters on this rule's ruleid. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

repeated string consumer_rules = 9 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The consumerRules at the given index.

getConsumerRulesBytes(int index)

public ByteString getConsumerRulesBytes(int index)

Output only. The names of the associated/chained consumer rules. Rules are considered consumers of this rule if their rule text explicitly filters on this rule's ruleid. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

repeated string consumer_rules = 9 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the consumerRules at the given index.

getConsumerRulesCount()

public int getConsumerRulesCount()

Output only. The names of the associated/chained consumer rules. Rules are considered consumers of this rule if their rule text explicitly filters on this rule's ruleid. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

repeated string consumer_rules = 9 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of consumerRules.

getConsumerRulesList()

public ProtocolStringList getConsumerRulesList()

Output only. The names of the associated/chained consumer rules. Rules are considered consumers of this rule if their rule text explicitly filters on this rule's ruleid. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

repeated string consumer_rules = 9 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the consumerRules.

getDefaultInstanceForType()

public RuleDeployment getDefaultInstanceForType()
Returns
Type Description
RuleDeployment

getEnabled()

public boolean getEnabled()

Whether the rule is currently deployed continuously against incoming data.

bool enabled = 2;

Returns
Type Description
boolean

The enabled.

getExecutionState()

public RuleDeployment.ExecutionState getExecutionState()

Output only. The execution state of the rule deployment.

.google.cloud.chronicle.v1.RuleDeployment.ExecutionState execution_state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
RuleDeployment.ExecutionState

The executionState.

getExecutionStateValue()

public int getExecutionStateValue()

Output only. The execution state of the rule deployment.

.google.cloud.chronicle.v1.RuleDeployment.ExecutionState execution_state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for executionState.

getLastAlertStatusChangeTime()

public Timestamp getLastAlertStatusChangeTime()

Output only. The timestamp when the rule deployment alert state was lastly changed. This is filled regardless of the current alert state. E.g. if the current alert status is false, this timestamp will be the timestamp when the alert status was changed to false.

.google.protobuf.Timestamp last_alert_status_change_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The lastAlertStatusChangeTime.

getLastAlertStatusChangeTimeOrBuilder()

public TimestampOrBuilder getLastAlertStatusChangeTimeOrBuilder()

Output only. The timestamp when the rule deployment alert state was lastly changed. This is filled regardless of the current alert state. E.g. if the current alert status is false, this timestamp will be the timestamp when the alert status was changed to false.

.google.protobuf.Timestamp last_alert_status_change_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getName()

public String getName()

Required. The resource name of the rule deployment. Note that RuleDeployment is a child of the overall Rule, not any individual revision, so the resource ID segment for the Rule resource must not reference a specific revision. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The resource name of the rule deployment. Note that RuleDeployment is a child of the overall Rule, not any individual revision, so the resource ID segment for the Rule resource must not reference a specific revision. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getProducerRules(int index)

public String getProducerRules(int index)

Output only. The names of the associated/chained producer rules. Rules are considered producers for this rule if this rule explicitly filters on their ruleid. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

repeated string producer_rules = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The producerRules at the given index.

getProducerRulesBytes(int index)

public ByteString getProducerRulesBytes(int index)

Output only. The names of the associated/chained producer rules. Rules are considered producers for this rule if this rule explicitly filters on their ruleid. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

repeated string producer_rules = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the producerRules at the given index.

getProducerRulesCount()

public int getProducerRulesCount()

Output only. The names of the associated/chained producer rules. Rules are considered producers for this rule if this rule explicitly filters on their ruleid. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

repeated string producer_rules = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of producerRules.

getProducerRulesList()

public ProtocolStringList getProducerRulesList()

Output only. The names of the associated/chained producer rules. Rules are considered producers for this rule if this rule explicitly filters on their ruleid. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

repeated string producer_rules = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the producerRules.

getRunFrequency()

public RunFrequency getRunFrequency()

The run frequency of the rule deployment.

.google.cloud.chronicle.v1.RunFrequency run_frequency = 6;

Returns
Type Description
RunFrequency

The runFrequency.

getRunFrequencyValue()

public int getRunFrequencyValue()

The run frequency of the rule deployment.

.google.cloud.chronicle.v1.RunFrequency run_frequency = 6;

Returns
Type Description
int

The enum numeric value on the wire for runFrequency.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasArchiveTime()

public boolean hasArchiveTime()

Output only. The timestamp when the rule deployment archive state was last set to true. If the rule deployment's current archive state is not set to true, the field will be empty.

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

Returns
Type Description
boolean

Whether the archiveTime field is set.

hasLastAlertStatusChangeTime()

public boolean hasLastAlertStatusChangeTime()

Output only. The timestamp when the rule deployment alert state was lastly changed. This is filled regardless of the current alert state. E.g. if the current alert status is false, this timestamp will be the timestamp when the alert status was changed to false.

.google.protobuf.Timestamp last_alert_status_change_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the lastAlertStatusChangeTime 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 RuleDeployment.Builder newBuilderForType()
Returns
Type Description
RuleDeployment.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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