Class ReportGenerationProgress.Builder (0.17.0)

public static final class ReportGenerationProgress.Builder extends GeneratedMessage.Builder<ReportGenerationProgress.Builder> implements ReportGenerationProgressOrBuilder

Details about the current status of the report-generation process.

Protobuf type google.cloud.auditmanager.v1.ReportGenerationProgress

Static Methods

getDescriptor()

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

Methods

build()

public ReportGenerationProgress build()
Returns
Type Description
ReportGenerationProgress

buildPartial()

public ReportGenerationProgress buildPartial()
Returns
Type Description
ReportGenerationProgress

clear()

public ReportGenerationProgress.Builder clear()
Returns
Type Description
ReportGenerationProgress.Builder
Overrides

clearAuditReport()

public ReportGenerationProgress.Builder clearAuditReport()

Output only. Name of the audit report.

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

Returns
Type Description
ReportGenerationProgress.Builder

This builder for chaining.

clearDestinationGcsBucket()

public ReportGenerationProgress.Builder clearDestinationGcsBucket()

Output only. Cloud Storage bucket where the audit report is uploaded to after the evaluation process is completed.

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

Returns
Type Description
ReportGenerationProgress.Builder

This builder for chaining.

clearEvaluationPercentComplete()

public ReportGenerationProgress.Builder clearEvaluationPercentComplete()

Progress of the evaluation process. The progress is defined in terms of percentage complete.

double evaluation_percent_complete = 20;

Returns
Type Description
ReportGenerationProgress.Builder

This builder for chaining.

clearFailureReason()

public ReportGenerationProgress.Builder clearFailureReason()

Output only. Reason for failure during the audit report generation process. This field is set only if the OperationState attribute is OPERATION_STATE_FAILED.

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

Returns
Type Description
ReportGenerationProgress.Builder

This builder for chaining.

clearReportGenerationPercentComplete()

public ReportGenerationProgress.Builder clearReportGenerationPercentComplete()

Report generation progress, defined in terms of percentage complete. Until evaluation is complete, this value is always 0.

double report_generation_percent_complete = 30;

Returns
Type Description
ReportGenerationProgress.Builder

This builder for chaining.

clearReportUploadingPercentComplete()

public ReportGenerationProgress.Builder clearReportUploadingPercentComplete()

Report uploading progress, defined in terms of percentage complete. Until evaluation and report generation are complete, this value is always 0.

double report_uploading_percent_complete = 40;

Returns
Type Description
ReportGenerationProgress.Builder

This builder for chaining.

clearState()

public ReportGenerationProgress.Builder clearState()

Output only. Current state of execution for report generation.

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

Returns
Type Description
ReportGenerationProgress.Builder

This builder for chaining.

getAuditReport()

public String getAuditReport()

Output only. 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. 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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDestinationGcsBucket()

public String getDestinationGcsBucket()

Output only. Cloud Storage bucket where the audit report is uploaded to after 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. Cloud Storage bucket where the audit report is uploaded to after 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()

Progress of the evaluation process. The progress is defined in terms of percentage complete.

double evaluation_percent_complete = 20;

Returns
Type Description
double

The evaluationPercentComplete.

getFailureReason()

public String getFailureReason()

Output only. Reason for failure during the audit report generation process. This field is set only if the OperationState 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. Reason for failure during the audit report generation process. This field is set only if the OperationState attribute is OPERATION_STATE_FAILED.

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

Returns
Type Description
ByteString

The bytes for failureReason.

getReportGenerationPercentComplete()

public double getReportGenerationPercentComplete()

Report generation progress, defined in terms of percentage complete. Until evaluation is complete, this value is always 0.

double report_generation_percent_complete = 30;

Returns
Type Description
double

The reportGenerationPercentComplete.

getReportUploadingPercentComplete()

public double getReportUploadingPercentComplete()

Report uploading progress, defined in terms of percentage complete. Until evaluation and report generation are complete, this value is always 0.

double report_uploading_percent_complete = 40;

Returns
Type Description
double

The reportUploadingPercentComplete.

getState()

public OperationState getState()

Output only. 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. 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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ReportGenerationProgress other)

public ReportGenerationProgress.Builder mergeFrom(ReportGenerationProgress other)
Parameter
Name Description
other ReportGenerationProgress
Returns
Type Description
ReportGenerationProgress.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ReportGenerationProgress.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReportGenerationProgress.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ReportGenerationProgress.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ReportGenerationProgress.Builder
Overrides

setAuditReport(String value)

public ReportGenerationProgress.Builder setAuditReport(String value)

Output only. Name of the audit report.

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

Parameter
Name Description
value String

The auditReport to set.

Returns
Type Description
ReportGenerationProgress.Builder

This builder for chaining.

setAuditReportBytes(ByteString value)

public ReportGenerationProgress.Builder setAuditReportBytes(ByteString value)

Output only. Name of the audit report.

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

Parameter
Name Description
value ByteString

The bytes for auditReport to set.

Returns
Type Description
ReportGenerationProgress.Builder

This builder for chaining.

setDestinationGcsBucket(String value)

public ReportGenerationProgress.Builder setDestinationGcsBucket(String value)

Output only. Cloud Storage bucket where the audit report is uploaded to after the evaluation process is completed.

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

Parameter
Name Description
value String

The destinationGcsBucket to set.

Returns
Type Description
ReportGenerationProgress.Builder

This builder for chaining.

setDestinationGcsBucketBytes(ByteString value)

public ReportGenerationProgress.Builder setDestinationGcsBucketBytes(ByteString value)

Output only. Cloud Storage bucket where the audit report is uploaded to after the evaluation process is completed.

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

Parameter
Name Description
value ByteString

The bytes for destinationGcsBucket to set.

Returns
Type Description
ReportGenerationProgress.Builder

This builder for chaining.

setEvaluationPercentComplete(double value)

public ReportGenerationProgress.Builder setEvaluationPercentComplete(double value)

Progress of the evaluation process. The progress is defined in terms of percentage complete.

double evaluation_percent_complete = 20;

Parameter
Name Description
value double

The evaluationPercentComplete to set.

Returns
Type Description
ReportGenerationProgress.Builder

This builder for chaining.

setFailureReason(String value)

public ReportGenerationProgress.Builder setFailureReason(String value)

Output only. Reason for failure during the audit report generation process. This field is set only if the OperationState attribute is OPERATION_STATE_FAILED.

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

Parameter
Name Description
value String

The failureReason to set.

Returns
Type Description
ReportGenerationProgress.Builder

This builder for chaining.

setFailureReasonBytes(ByteString value)

public ReportGenerationProgress.Builder setFailureReasonBytes(ByteString value)

Output only. Reason for failure during the audit report generation process. This field is set only if the OperationState attribute is OPERATION_STATE_FAILED.

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

Parameter
Name Description
value ByteString

The bytes for failureReason to set.

Returns
Type Description
ReportGenerationProgress.Builder

This builder for chaining.

setReportGenerationPercentComplete(double value)

public ReportGenerationProgress.Builder setReportGenerationPercentComplete(double value)

Report generation progress, defined in terms of percentage complete. Until evaluation is complete, this value is always 0.

double report_generation_percent_complete = 30;

Parameter
Name Description
value double

The reportGenerationPercentComplete to set.

Returns
Type Description
ReportGenerationProgress.Builder

This builder for chaining.

setReportUploadingPercentComplete(double value)

public ReportGenerationProgress.Builder setReportUploadingPercentComplete(double value)

Report uploading progress, defined in terms of percentage complete. Until evaluation and report generation are complete, this value is always 0.

double report_uploading_percent_complete = 40;

Parameter
Name Description
value double

The reportUploadingPercentComplete to set.

Returns
Type Description
ReportGenerationProgress.Builder

This builder for chaining.

setState(OperationState value)

public ReportGenerationProgress.Builder setState(OperationState value)

Output only. Current state of execution for report generation.

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

Parameter
Name Description
value OperationState

The state to set.

Returns
Type Description
ReportGenerationProgress.Builder

This builder for chaining.

setStateValue(int value)

public ReportGenerationProgress.Builder setStateValue(int value)

Output only. Current state of execution for report generation.

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

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.

Returns
Type Description
ReportGenerationProgress.Builder

This builder for chaining.