Interface AuditScheduleOrBuilder (0.17.0) 

public interface AuditScheduleOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getComplianceFramework()

public abstract String getComplianceFramework()

Required. Framework (set of controls) that the audit scope report is generated against. For example, NIST_800_53.

string compliance_framework = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The complianceFramework.

getComplianceFrameworkBytes()

public abstract ByteString getComplianceFrameworkBytes()

Required. Framework (set of controls) that the audit scope report is generated against. For example, NIST_800_53.

string compliance_framework = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for complianceFramework.

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Timestamp when the schedule was created.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when the schedule was created.

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

Returns
Type Description
TimestampOrBuilder

getDisplayName()

public abstract String getDisplayName()

Optional. Display name for the audit schedule.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Optional. Display name for the audit schedule.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

getErrorMessage()

public abstract String getErrorMessage()

Output only. Describes the error if the schedule is in an error state.

string error_message = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The errorMessage.

getErrorMessageBytes()

public abstract ByteString getErrorMessageBytes()

Output only. Describes the error if the schedule is in an error state.

string error_message = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for errorMessage.

getGcsUri()

public abstract String getGcsUri()

Required. Cloud Storage bucket where Audit Manager can upload the audit report and evidence. The format is gs://{bucket_name}.

string gcs_uri = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The gcsUri.

getGcsUriBytes()

public abstract ByteString getGcsUriBytes()

Required. Cloud Storage bucket where Audit Manager can upload the audit report and evidence. The format is gs://{bucket_name}.

string gcs_uri = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for gcsUri.

getLastTriggerTime()

public abstract Timestamp getLastTriggerTime()

Output only. Timestamp when the audit run was last triggered.

.google.protobuf.Timestamp last_trigger_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The lastTriggerTime.

getLastTriggerTimeOrBuilder()

public abstract TimestampOrBuilder getLastTriggerTimeOrBuilder()

Output only. Timestamp when the audit run was last triggered.

.google.protobuf.Timestamp last_trigger_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getName()

public abstract String getName()

Identifier. Unique identifier for the audit schedule. Format: projects/{project}/locations/{location}/auditSchedules/{audit_schedule} folders/{folder}/locations/{location}/auditSchedules/{audit_schedule} organizations/{organization}/locations/{location}/auditSchedules/{audit_schedule}

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

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. Unique identifier for the audit schedule. Format: projects/{project}/locations/{location}/auditSchedules/{audit_schedule} folders/{folder}/locations/{location}/auditSchedules/{audit_schedule} organizations/{organization}/locations/{location}/auditSchedules/{audit_schedule}

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

Returns
Type Description
ByteString

The bytes for name.

getNextRunTime()

public abstract Timestamp getNextRunTime()

Output only. Calculated timestamp for the next scheduled run.

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

Returns
Type Description
Timestamp

The nextRunTime.

getNextRunTimeOrBuilder()

public abstract TimestampOrBuilder getNextRunTimeOrBuilder()

Output only. Calculated timestamp for the next scheduled run.

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

Returns
Type Description
TimestampOrBuilder

getReportFormat()

public abstract AuditSchedule.AuditReportFormat getReportFormat()

Required. Format for the audit report.

.google.cloud.auditmanager.v1.AuditSchedule.AuditReportFormat report_format = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AuditSchedule.AuditReportFormat

The reportFormat.

getReportFormatValue()

public abstract int getReportFormatValue()

Required. Format for the audit report.

.google.cloud.auditmanager.v1.AuditSchedule.AuditReportFormat report_format = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for reportFormat.

getScheduleConfig()

public abstract ScheduleConfig getScheduleConfig()

Required. Configuration that defines when and how often audit runs are automatically triggered for this schedule.

.google.cloud.auditmanager.v1.ScheduleConfig schedule_config = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ScheduleConfig

The scheduleConfig.

getScheduleConfigOrBuilder()

public abstract ScheduleConfigOrBuilder getScheduleConfigOrBuilder()

Required. Configuration that defines when and how often audit runs are automatically triggered for this schedule.

.google.cloud.auditmanager.v1.ScheduleConfig schedule_config = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ScheduleConfigOrBuilder

getState()

public abstract ScheduleState getState()

Optional. State of the audit schedule. While most states are managed by the system, you can use UpdateAuditSchedule to start, pause, or delete the schedule.

.google.cloud.auditmanager.v1.ScheduleState state = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ScheduleState

The state.

getStateValue()

public abstract int getStateValue()

Optional. State of the audit schedule. While most states are managed by the system, you can use UpdateAuditSchedule to start, pause, or delete the schedule.

.google.cloud.auditmanager.v1.ScheduleState state = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for state.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. Timestamp when the schedule was last updated.

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when the schedule was last updated.

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

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Timestamp when the schedule was created.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasLastTriggerTime()

public abstract boolean hasLastTriggerTime()

Output only. Timestamp when the audit run was last triggered.

.google.protobuf.Timestamp last_trigger_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the lastTriggerTime field is set.

hasNextRunTime()

public abstract boolean hasNextRunTime()

Output only. Calculated timestamp for the next scheduled run.

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

Returns
Type Description
boolean

Whether the nextRunTime field is set.

hasScheduleConfig()

public abstract boolean hasScheduleConfig()

Required. Configuration that defines when and how often audit runs are automatically triggered for this schedule.

.google.cloud.auditmanager.v1.ScheduleConfig schedule_config = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the scheduleConfig field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. Timestamp when the schedule was last updated.

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

Returns
Type Description
boolean

Whether the updateTime field is set.