public static final class RuleDeployment.Builder extends GeneratedMessageV3.Builder<RuleDeployment.Builder> implements RuleDeploymentOrBuilderThe RuleDeployment resource represents the deployment state of a Rule.
Protobuf type google.cloud.chronicle.v1.RuleDeployment
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RuleDeployment.BuilderImplements
RuleDeploymentOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllConsumerRules(Iterable<String> values)
public RuleDeployment.Builder addAllConsumerRules(Iterable<String> values) 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 |
values |
Iterable<String>The consumerRules to add. |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
This builder for chaining. |
addAllProducerRules(Iterable<String> values)
public RuleDeployment.Builder addAllProducerRules(Iterable<String> values) 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 |
values |
Iterable<String>The producerRules to add. |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
This builder for chaining. |
addConsumerRules(String value)
public RuleDeployment.Builder addConsumerRules(String value) 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 |
value |
StringThe consumerRules to add. |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
This builder for chaining. |
addConsumerRulesBytes(ByteString value)
public RuleDeployment.Builder addConsumerRulesBytes(ByteString value) 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 |
value |
ByteStringThe bytes of the consumerRules to add. |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
This builder for chaining. |
addProducerRules(String value)
public RuleDeployment.Builder addProducerRules(String value) 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 |
value |
StringThe producerRules to add. |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
This builder for chaining. |
addProducerRulesBytes(ByteString value)
public RuleDeployment.Builder addProducerRulesBytes(ByteString value) 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 |
value |
ByteStringThe bytes of the producerRules to add. |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public RuleDeployment.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
|
build()
public RuleDeployment build()| Returns | |
|---|---|
| Type | Description |
RuleDeployment |
|
buildPartial()
public RuleDeployment buildPartial()| Returns | |
|---|---|
| Type | Description |
RuleDeployment |
|
clear()
public RuleDeployment.Builder clear()| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
|
clearAlerting()
public RuleDeployment.Builder clearAlerting()Whether detections resulting from this deployment should be considered alerts.
bool alerting = 3;
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
This builder for chaining. |
clearArchiveTime()
public RuleDeployment.Builder clearArchiveTime()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 |
RuleDeployment.Builder |
|
clearArchived()
public RuleDeployment.Builder clearArchived()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 |
RuleDeployment.Builder |
This builder for chaining. |
clearConsumerRules()
public RuleDeployment.Builder clearConsumerRules() 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 |
RuleDeployment.Builder |
This builder for chaining. |
clearEnabled()
public RuleDeployment.Builder clearEnabled()Whether the rule is currently deployed continuously against incoming data.
bool enabled = 2;
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
This builder for chaining. |
clearExecutionState()
public RuleDeployment.Builder clearExecutionState()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.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public RuleDeployment.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
|
clearLastAlertStatusChangeTime()
public RuleDeployment.Builder clearLastAlertStatusChangeTime()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 |
RuleDeployment.Builder |
|
clearName()
public RuleDeployment.Builder clearName() 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 |
RuleDeployment.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public RuleDeployment.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
|
clearProducerRules()
public RuleDeployment.Builder clearProducerRules() 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 |
RuleDeployment.Builder |
This builder for chaining. |
clearRunFrequency()
public RuleDeployment.Builder clearRunFrequency()The run frequency of the rule deployment.
.google.cloud.chronicle.v1.RunFrequency run_frequency = 6;
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
This builder for chaining. |
clone()
public RuleDeployment.Builder clone()| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
|
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. |
getArchiveTimeBuilder()
public Timestamp.Builder getArchiveTimeBuilder()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 |
Builder |
|
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 |
intThe 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 |
intThe 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 |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
getLastAlertStatusChangeTimeBuilder()
public Timestamp.Builder getLastAlertStatusChangeTimeBuilder()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 |
Builder |
|
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. |
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 |
intThe 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 |
intThe 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. |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeArchiveTime(Timestamp value)
public RuleDeployment.Builder mergeArchiveTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
|
mergeFrom(RuleDeployment other)
public RuleDeployment.Builder mergeFrom(RuleDeployment other)| Parameter | |
|---|---|
| Name | Description |
other |
RuleDeployment |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public RuleDeployment.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public RuleDeployment.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
|
mergeLastAlertStatusChangeTime(Timestamp value)
public RuleDeployment.Builder mergeLastAlertStatusChangeTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final RuleDeployment.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
|
setAlerting(boolean value)
public RuleDeployment.Builder setAlerting(boolean value)Whether detections resulting from this deployment should be considered alerts.
bool alerting = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe alerting to set. |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
This builder for chaining. |
setArchiveTime(Timestamp value)
public RuleDeployment.Builder setArchiveTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
|
setArchiveTime(Timestamp.Builder builderForValue)
public RuleDeployment.Builder setArchiveTime(Timestamp.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
|
setArchived(boolean value)
public RuleDeployment.Builder setArchived(boolean value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe archived to set. |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
This builder for chaining. |
setConsumerRules(int index, String value)
public RuleDeployment.Builder setConsumerRules(int index, String value) 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) = { ... }
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe consumerRules to set. |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
This builder for chaining. |
setEnabled(boolean value)
public RuleDeployment.Builder setEnabled(boolean value)Whether the rule is currently deployed continuously against incoming data.
bool enabled = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe enabled to set. |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
This builder for chaining. |
setExecutionState(RuleDeployment.ExecutionState value)
public RuleDeployment.Builder setExecutionState(RuleDeployment.ExecutionState value)Output only. The execution state of the rule deployment.
.google.cloud.chronicle.v1.RuleDeployment.ExecutionState execution_state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
RuleDeployment.ExecutionStateThe executionState to set. |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
This builder for chaining. |
setExecutionStateValue(int value)
public RuleDeployment.Builder setExecutionStateValue(int value)Output only. The execution state of the rule deployment.
.google.cloud.chronicle.v1.RuleDeployment.ExecutionState execution_state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for executionState to set. |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public RuleDeployment.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
|
setLastAlertStatusChangeTime(Timestamp value)
public RuleDeployment.Builder setLastAlertStatusChangeTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
|
setLastAlertStatusChangeTime(Timestamp.Builder builderForValue)
public RuleDeployment.Builder setLastAlertStatusChangeTime(Timestamp.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
|
setName(String value)
public RuleDeployment.Builder setName(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public RuleDeployment.Builder setNameBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
This builder for chaining. |
setProducerRules(int index, String value)
public RuleDeployment.Builder setProducerRules(int index, String value) 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) = { ... }
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe producerRules to set. |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public RuleDeployment.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
|
setRunFrequency(RunFrequency value)
public RuleDeployment.Builder setRunFrequency(RunFrequency value)The run frequency of the rule deployment.
.google.cloud.chronicle.v1.RunFrequency run_frequency = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
RunFrequencyThe runFrequency to set. |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
This builder for chaining. |
setRunFrequencyValue(int value)
public RuleDeployment.Builder setRunFrequencyValue(int value)The run frequency of the rule deployment.
.google.cloud.chronicle.v1.RunFrequency run_frequency = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for runFrequency to set. |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final RuleDeployment.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
RuleDeployment.Builder |
|