Class ReportGenerationProgress (0.3.0)

public final class ReportGenerationProgress extends GeneratedMessage implements ReportGenerationProgressOrBuilder

The ReportGenerationProgress is part of google.longrunning.Operation returned to the client for every GetOperation request.

Protobuf type google.cloud.auditmanager.v1.ReportGenerationProgress

Static Fields

AUDIT_REPORT_FIELD_NUMBER

public static final int AUDIT_REPORT_FIELD_NUMBER
Field Value
Type Description
int

DESTINATION_GCS_BUCKET_FIELD_NUMBER

public static final int DESTINATION_GCS_BUCKET_FIELD_NUMBER
Field Value
Type Description
int

EVALUATION_PERCENT_COMPLETE_FIELD_NUMBER

public static final int EVALUATION_PERCENT_COMPLETE_FIELD_NUMBER
Field Value
Type Description
int

FAILURE_REASON_FIELD_NUMBER

public static final int FAILURE_REASON_FIELD_NUMBER
Field Value
Type Description
int

REPORT_GENERATION_PERCENT_COMPLETE_FIELD_NUMBER

public static final int REPORT_GENERATION_PERCENT_COMPLETE_FIELD_NUMBER
Field Value
Type Description
int

REPORT_UPLOADING_PERCENT_COMPLETE_FIELD_NUMBER

public static final int REPORT_UPLOADING_PERCENT_COMPLETE_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ReportGenerationProgress getDefaultInstance()
Returns
Type Description
ReportGenerationProgress

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ReportGenerationProgress.Builder newBuilder()
Returns
Type Description
ReportGenerationProgress.Builder

newBuilder(ReportGenerationProgress prototype)

public static ReportGenerationProgress.Builder newBuilder(ReportGenerationProgress prototype)
Parameter
Name Description
prototype ReportGenerationProgress
Returns
Type Description
ReportGenerationProgress.Builder

parseDelimitedFrom(InputStream input)

public static ReportGenerationProgress parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ReportGenerationProgress
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReportGenerationProgress parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReportGenerationProgress
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ReportGenerationProgress parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ReportGenerationProgress
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ReportGenerationProgress parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReportGenerationProgress
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ReportGenerationProgress parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ReportGenerationProgress
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ReportGenerationProgress parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReportGenerationProgress
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ReportGenerationProgress parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ReportGenerationProgress
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ReportGenerationProgress parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReportGenerationProgress
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ReportGenerationProgress parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ReportGenerationProgress
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReportGenerationProgress parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReportGenerationProgress
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ReportGenerationProgress parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ReportGenerationProgress
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ReportGenerationProgress parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReportGenerationProgress
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ReportGenerationProgress> parser()
Returns
Type Description
Parser<ReportGenerationProgress>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAuditReport()

public String getAuditReport()

Output only. The name of the audit report.

string audit_report = 51 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The auditReport.

getAuditReportBytes()

public ByteString getAuditReportBytes()

Output only. The name of the audit report.

string audit_report = 51 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for auditReport.

getDefaultInstanceForType()

public ReportGenerationProgress getDefaultInstanceForType()
Returns
Type Description
ReportGenerationProgress

getDestinationGcsBucket()

public String getDestinationGcsBucket()

Output only. The Cloud Storage bucket where the audit report will be uploaded once the evaluation process is completed.

string destination_gcs_bucket = 50 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The destinationGcsBucket.

getDestinationGcsBucketBytes()

public ByteString getDestinationGcsBucketBytes()

Output only. The Cloud Storage bucket where the audit report will be uploaded once the evaluation process is completed.

string destination_gcs_bucket = 50 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for destinationGcsBucket.

getEvaluationPercentComplete()

public double getEvaluationPercentComplete()

Shows the progress of the CESS service evaluation process. The progress is defined in terms of percentage complete and is being fetched from the CESS service.

double evaluation_percent_complete = 20;

Returns
Type Description
double

The evaluationPercentComplete.

getFailureReason()

public String getFailureReason()

Output only. States the reason of failure during the audit report generation process. This field is set only if the state attribute is OPERATION_STATE_FAILED.

string failure_reason = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The failureReason.

getFailureReasonBytes()

public ByteString getFailureReasonBytes()

Output only. States the reason of failure during the audit report generation process. This field is set only if the state attribute is OPERATION_STATE_FAILED.

string failure_reason = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for failureReason.

getParserForType()

public Parser<ReportGenerationProgress> getParserForType()
Returns
Type Description
Parser<ReportGenerationProgress>
Overrides

getReportGenerationPercentComplete()

public double getReportGenerationPercentComplete()

Shows the report generation progress of the CESS Result Processor Service. The // progress is defined in terms of percentage complete and is being fetched from the CESS service. If report_generation_in_progress is non zero then evaluation_percent_complete will be 100%.

double report_generation_percent_complete = 30;

Returns
Type Description
double

The reportGenerationPercentComplete.

getReportUploadingPercentComplete()

public double getReportUploadingPercentComplete()

Shows the report uploading progress of the CESS Result Processor Service. The progress is defined in terms of percentage complete and is being fetched from the CESS service. If report_uploading_in_progress is non zero then evaluation_percent_complete and report_generation_percent_complete will be 100%.

double report_uploading_percent_complete = 40;

Returns
Type Description
double

The reportUploadingPercentComplete.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public OperationState getState()

Output only. The current state of execution for report generation.

.google.cloud.auditmanager.v1.OperationState state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
OperationState

The state.

getStateValue()

public int getStateValue()

Output only. The current state of execution for report generation.

.google.cloud.auditmanager.v1.OperationState state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ReportGenerationProgress.Builder newBuilderForType()
Returns
Type Description
ReportGenerationProgress.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ReportGenerationProgress.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ReportGenerationProgress.Builder
Overrides

toBuilder()

public ReportGenerationProgress.Builder toBuilder()
Returns
Type Description
ReportGenerationProgress.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException