Reference documentation and code samples for the Audit Manager V1 API class Google::Cloud::AuditManager::V1::AuditSchedule.
An audit schedule, in one of the following formats:
projects/{project}/locations/{location}/auditSchedules/{audit_schedule}folders/{folder}/locations/{location}/auditSchedules/{audit_schedule}
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#compliance_framework
def compliance_framework() -> ::String
Returns
-
(::String) — Required. Framework (set of controls) that the audit scope report is
generated against. For example,
NIST_800_53.
#compliance_framework=
def compliance_framework=(value) -> ::String
Parameter
-
value (::String) — Required. Framework (set of controls) that the audit scope report is
generated against. For example,
NIST_800_53.
Returns
-
(::String) — Required. Framework (set of controls) that the audit scope report is
generated against. For example,
NIST_800_53.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Timestamp when the schedule was created.
#display_name
def display_name() -> ::String
Returns
- (::String) — Optional. Display name for the audit schedule.
#display_name=
def display_name=(value) -> ::String
Parameter
- value (::String) — Optional. Display name for the audit schedule.
Returns
- (::String) — Optional. Display name for the audit schedule.
#error_message
def error_message() -> ::String
Returns
- (::String) — Output only. Describes the error if the schedule is in an error state.
#gcs_uri
def gcs_uri() -> ::String
Returns
-
(::String) — Required. Cloud Storage bucket where Audit Manager can upload the audit
report and evidence. The format is
gs://{bucket_name}.
#gcs_uri=
def gcs_uri=(value) -> ::String
Parameter
-
value (::String) — Required. Cloud Storage bucket where Audit Manager can upload the audit
report and evidence. The format is
gs://{bucket_name}.
Returns
-
(::String) — Required. Cloud Storage bucket where Audit Manager can upload the audit
report and evidence. The format is
gs://{bucket_name}.
#last_trigger_time
def last_trigger_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Timestamp when the audit run was last triggered.
#name
def name() -> ::String
Returns
- (::String) — 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}
#name=
def name=(value) -> ::String
Parameter
- value (::String) — 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}
Returns
- (::String) — 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}
#next_run_time
def next_run_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Calculated timestamp for the next scheduled run.
#report_format
def report_format() -> ::Google::Cloud::AuditManager::V1::AuditSchedule::AuditReportFormat
Returns
- (::Google::Cloud::AuditManager::V1::AuditSchedule::AuditReportFormat) — Required. Format for the audit report.
#report_format=
def report_format=(value) -> ::Google::Cloud::AuditManager::V1::AuditSchedule::AuditReportFormat
Parameter
- value (::Google::Cloud::AuditManager::V1::AuditSchedule::AuditReportFormat) — Required. Format for the audit report.
Returns
- (::Google::Cloud::AuditManager::V1::AuditSchedule::AuditReportFormat) — Required. Format for the audit report.
#schedule_config
def schedule_config() -> ::Google::Cloud::AuditManager::V1::ScheduleConfig
Returns
- (::Google::Cloud::AuditManager::V1::ScheduleConfig) — Required. Configuration that defines when and how often audit runs are automatically triggered for this schedule.
#schedule_config=
def schedule_config=(value) -> ::Google::Cloud::AuditManager::V1::ScheduleConfig
Parameter
- value (::Google::Cloud::AuditManager::V1::ScheduleConfig) — Required. Configuration that defines when and how often audit runs are automatically triggered for this schedule.
Returns
- (::Google::Cloud::AuditManager::V1::ScheduleConfig) — Required. Configuration that defines when and how often audit runs are automatically triggered for this schedule.
#state
def state() -> ::Google::Cloud::AuditManager::V1::ScheduleState
Returns
- (::Google::Cloud::AuditManager::V1::ScheduleState) — 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.
#state=
def state=(value) -> ::Google::Cloud::AuditManager::V1::ScheduleState
Parameter
- value (::Google::Cloud::AuditManager::V1::ScheduleState) — 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.
Returns
- (::Google::Cloud::AuditManager::V1::ScheduleState) — 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.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Timestamp when the schedule was last updated.