com.pulumi.googlenative.monitoring.v3.outputs.GetAlertPolicyResult Maven / Gradle / Ivy
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.googlenative.monitoring.v3.outputs;
import com.pulumi.core.annotations.CustomType;
import com.pulumi.googlenative.monitoring.v3.outputs.AlertStrategyResponse;
import com.pulumi.googlenative.monitoring.v3.outputs.ConditionResponse;
import com.pulumi.googlenative.monitoring.v3.outputs.DocumentationResponse;
import com.pulumi.googlenative.monitoring.v3.outputs.MutationRecordResponse;
import com.pulumi.googlenative.monitoring.v3.outputs.StatusResponse;
import java.lang.Boolean;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Objects;
@CustomType
public final class GetAlertPolicyResult {
/**
* @return Control over how this alert policy's notification channels are notified.
*
*/
private AlertStrategyResponse alertStrategy;
/**
* @return How to combine the results of multiple conditions to determine if an incident should be opened. If condition_time_series_query_language is present, this must be COMBINE_UNSPECIFIED.
*
*/
private String combiner;
/**
* @return A list of conditions for the policy. The conditions are combined by AND or OR according to the combiner field. If the combined conditions evaluate to true, then an incident is created. A policy can have from one to six conditions. If condition_time_series_query_language is present, it must be the only condition. If condition_monitoring_query_language is present, it must be the only condition.
*
*/
private List conditions;
/**
* @return A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored.
*
*/
private MutationRecordResponse creationRecord;
/**
* @return A short name or phrase used to identify the policy in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple policies in the same project. The name is limited to 512 Unicode characters.
*
*/
private String displayName;
/**
* @return Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation.
*
*/
private DocumentationResponse documentation;
/**
* @return Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out.
*
*/
private Boolean enabled;
/**
* @return A read-only record of the most recent change to the alerting policy. If provided in a call to create or update, this field will be ignored.
*
*/
private MutationRecordResponse mutationRecord;
/**
* @return Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request.
*
*/
private String name;
/**
* @return Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident. Each element of this array corresponds to the name field in each of the NotificationChannel objects that are returned from the ListNotificationChannels method. The format of the entries in this field is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
*
*/
private List notificationChannels;
/**
* @return User-supplied key/value data to be used for organizing and identifying the AlertPolicy objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.
*
*/
private Map userLabels;
/**
* @return Read-only description of how the alert policy is invalid. OK if the alert policy is valid. If not OK, the alert policy will not generate incidents.
*
*/
private StatusResponse validity;
private GetAlertPolicyResult() {}
/**
* @return Control over how this alert policy's notification channels are notified.
*
*/
public AlertStrategyResponse alertStrategy() {
return this.alertStrategy;
}
/**
* @return How to combine the results of multiple conditions to determine if an incident should be opened. If condition_time_series_query_language is present, this must be COMBINE_UNSPECIFIED.
*
*/
public String combiner() {
return this.combiner;
}
/**
* @return A list of conditions for the policy. The conditions are combined by AND or OR according to the combiner field. If the combined conditions evaluate to true, then an incident is created. A policy can have from one to six conditions. If condition_time_series_query_language is present, it must be the only condition. If condition_monitoring_query_language is present, it must be the only condition.
*
*/
public List conditions() {
return this.conditions;
}
/**
* @return A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored.
*
*/
public MutationRecordResponse creationRecord() {
return this.creationRecord;
}
/**
* @return A short name or phrase used to identify the policy in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple policies in the same project. The name is limited to 512 Unicode characters.
*
*/
public String displayName() {
return this.displayName;
}
/**
* @return Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation.
*
*/
public DocumentationResponse documentation() {
return this.documentation;
}
/**
* @return Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out.
*
*/
public Boolean enabled() {
return this.enabled;
}
/**
* @return A read-only record of the most recent change to the alerting policy. If provided in a call to create or update, this field will be ignored.
*
*/
public MutationRecordResponse mutationRecord() {
return this.mutationRecord;
}
/**
* @return Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request.
*
*/
public String name() {
return this.name;
}
/**
* @return Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident. Each element of this array corresponds to the name field in each of the NotificationChannel objects that are returned from the ListNotificationChannels method. The format of the entries in this field is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
*
*/
public List notificationChannels() {
return this.notificationChannels;
}
/**
* @return User-supplied key/value data to be used for organizing and identifying the AlertPolicy objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.
*
*/
public Map userLabels() {
return this.userLabels;
}
/**
* @return Read-only description of how the alert policy is invalid. OK if the alert policy is valid. If not OK, the alert policy will not generate incidents.
*
*/
public StatusResponse validity() {
return this.validity;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(GetAlertPolicyResult defaults) {
return new Builder(defaults);
}
@CustomType.Builder
public static final class Builder {
private AlertStrategyResponse alertStrategy;
private String combiner;
private List conditions;
private MutationRecordResponse creationRecord;
private String displayName;
private DocumentationResponse documentation;
private Boolean enabled;
private MutationRecordResponse mutationRecord;
private String name;
private List notificationChannels;
private Map userLabels;
private StatusResponse validity;
public Builder() {}
public Builder(GetAlertPolicyResult defaults) {
Objects.requireNonNull(defaults);
this.alertStrategy = defaults.alertStrategy;
this.combiner = defaults.combiner;
this.conditions = defaults.conditions;
this.creationRecord = defaults.creationRecord;
this.displayName = defaults.displayName;
this.documentation = defaults.documentation;
this.enabled = defaults.enabled;
this.mutationRecord = defaults.mutationRecord;
this.name = defaults.name;
this.notificationChannels = defaults.notificationChannels;
this.userLabels = defaults.userLabels;
this.validity = defaults.validity;
}
@CustomType.Setter
public Builder alertStrategy(AlertStrategyResponse alertStrategy) {
this.alertStrategy = Objects.requireNonNull(alertStrategy);
return this;
}
@CustomType.Setter
public Builder combiner(String combiner) {
this.combiner = Objects.requireNonNull(combiner);
return this;
}
@CustomType.Setter
public Builder conditions(List conditions) {
this.conditions = Objects.requireNonNull(conditions);
return this;
}
public Builder conditions(ConditionResponse... conditions) {
return conditions(List.of(conditions));
}
@CustomType.Setter
public Builder creationRecord(MutationRecordResponse creationRecord) {
this.creationRecord = Objects.requireNonNull(creationRecord);
return this;
}
@CustomType.Setter
public Builder displayName(String displayName) {
this.displayName = Objects.requireNonNull(displayName);
return this;
}
@CustomType.Setter
public Builder documentation(DocumentationResponse documentation) {
this.documentation = Objects.requireNonNull(documentation);
return this;
}
@CustomType.Setter
public Builder enabled(Boolean enabled) {
this.enabled = Objects.requireNonNull(enabled);
return this;
}
@CustomType.Setter
public Builder mutationRecord(MutationRecordResponse mutationRecord) {
this.mutationRecord = Objects.requireNonNull(mutationRecord);
return this;
}
@CustomType.Setter
public Builder name(String name) {
this.name = Objects.requireNonNull(name);
return this;
}
@CustomType.Setter
public Builder notificationChannels(List notificationChannels) {
this.notificationChannels = Objects.requireNonNull(notificationChannels);
return this;
}
public Builder notificationChannels(String... notificationChannels) {
return notificationChannels(List.of(notificationChannels));
}
@CustomType.Setter
public Builder userLabels(Map userLabels) {
this.userLabels = Objects.requireNonNull(userLabels);
return this;
}
@CustomType.Setter
public Builder validity(StatusResponse validity) {
this.validity = Objects.requireNonNull(validity);
return this;
}
public GetAlertPolicyResult build() {
final var o = new GetAlertPolicyResult();
o.alertStrategy = alertStrategy;
o.combiner = combiner;
o.conditions = conditions;
o.creationRecord = creationRecord;
o.displayName = displayName;
o.documentation = documentation;
o.enabled = enabled;
o.mutationRecord = mutationRecord;
o.name = name;
o.notificationChannels = notificationChannels;
o.userLabels = userLabels;
o.validity = validity;
return o;
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy