Class AuditSchedule (0.17.0)

0.17.0 (latest) 0.13.0 0.12.0 0.11.0 0.9.0 0.6.0 0.5.0 0.3.0 0.1.0

public final class AuditSchedule extends GeneratedMessage implements AuditScheduleOrBuilder

An audit schedule, in one of the following formats:

• projects/{project}/locations/{location}/auditSchedules/{audit_schedule}
• folders/{folder}/locations/{location}/auditSchedules/{audit_schedule}

Protobuf type google.cloud.auditmanager.v1.AuditSchedule

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > AuditSchedule

Implements

AuditScheduleOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

COMPLIANCE_FRAMEWORK_FIELD_NUMBER

public static final int COMPLIANCE_FRAMEWORK_FIELD_NUMBER

Field Value
Type	Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

Field Value
Type	Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

Field Value
Type	Description
int

ERROR_MESSAGE_FIELD_NUMBER

public static final int ERROR_MESSAGE_FIELD_NUMBER

Field Value
Type	Description
int

GCS_URI_FIELD_NUMBER

public static final int GCS_URI_FIELD_NUMBER

Field Value
Type	Description
int

LAST_TRIGGER_TIME_FIELD_NUMBER

public static final int LAST_TRIGGER_TIME_FIELD_NUMBER

Field Value
Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
int

NEXT_RUN_TIME_FIELD_NUMBER

public static final int NEXT_RUN_TIME_FIELD_NUMBER

Field Value
Type	Description
int

REPORT_FORMAT_FIELD_NUMBER

public static final int REPORT_FORMAT_FIELD_NUMBER

Field Value
Type	Description
int

SCHEDULE_CONFIG_FIELD_NUMBER

public static final int SCHEDULE_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

Field Value
Type	Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static AuditSchedule getDefaultInstance()

Returns
Type	Description
AuditSchedule

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static AuditSchedule.Builder newBuilder()

Returns
Type	Description
AuditSchedule.Builder

newBuilder(AuditSchedule prototype)

public static AuditSchedule.Builder newBuilder(AuditSchedule prototype)

Parameter
Name	Description
prototype	AuditSchedule

Returns
Type	Description
AuditSchedule.Builder

parseDelimitedFrom(InputStream input)

public static AuditSchedule parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
AuditSchedule

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AuditSchedule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AuditSchedule

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static AuditSchedule parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
AuditSchedule

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AuditSchedule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AuditSchedule

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AuditSchedule parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
AuditSchedule

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AuditSchedule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AuditSchedule

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AuditSchedule parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
AuditSchedule

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AuditSchedule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AuditSchedule

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static AuditSchedule parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
AuditSchedule

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AuditSchedule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AuditSchedule

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static AuditSchedule parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
AuditSchedule

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AuditSchedule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AuditSchedule

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<AuditSchedule> parser()

Returns
Type	Description
Parser<AuditSchedule>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getComplianceFramework()

public 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 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 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 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

getDefaultInstanceForType()

public AuditSchedule getDefaultInstanceForType()

Returns
Type	Description
AuditSchedule

getDisplayName()

public 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 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 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 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 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 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 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 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 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 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 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 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

getParserForType()

public Parser<AuditSchedule> getParserForType()

Returns
Type	Description
Parser<AuditSchedule>

Overrides

GeneratedMessage.getParserForType()

getReportFormat()

public 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 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 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 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

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

getState()

public 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 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 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 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 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 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 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 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 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.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public AuditSchedule.Builder newBuilderForType()

Returns
Type	Description
AuditSchedule.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected AuditSchedule.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
AuditSchedule.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public AuditSchedule.Builder toBuilder()

Returns
Type	Description
AuditSchedule.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException