Class GenerateAuditReportRequest.Builder (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 static final class GenerateAuditReportRequest.Builder extends GeneratedMessage.Builder<GenerateAuditReportRequest.Builder> implements GenerateAuditReportRequestOrBuilder

Request message for GenerateAuditReport.

Protobuf type google.cloud.auditmanager.v1.GenerateAuditReportRequest

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > GenerateAuditReportRequest.Builder

Implements

GenerateAuditReportRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

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

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

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

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

build()

public GenerateAuditReportRequest build()

Returns
Type	Description
GenerateAuditReportRequest

buildPartial()

public GenerateAuditReportRequest buildPartial()

Returns
Type	Description
GenerateAuditReportRequest

clear()

public GenerateAuditReportRequest.Builder clear()

Returns
Type	Description
GenerateAuditReportRequest.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearComplianceFramework()

public GenerateAuditReportRequest.Builder clearComplianceFramework()

Required. The framework that's used for the audit report. For example, NIST_800_53.

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

Returns
Type	Description
GenerateAuditReportRequest.Builder	This builder for chaining.

clearComplianceStandard() (deprecated)

public GenerateAuditReportRequest.Builder clearComplianceStandard()

Deprecated. google.cloud.auditmanager.v1.GenerateAuditReportRequest.compliance_standard is deprecated. See google/cloud/auditmanager/v1/auditmanager.proto;l=478

Optional. Deprecated. Compliance standard for the audit report.

Use the compliance_framework field instead.

string compliance_standard = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
GenerateAuditReportRequest.Builder	This builder for chaining.

clearDestination()

public GenerateAuditReportRequest.Builder clearDestination()

Returns
Type	Description
GenerateAuditReportRequest.Builder

clearGcsUri()

public GenerateAuditReportRequest.Builder clearGcsUri()

URL for the Cloud Storage bucket where the report and evidence is uploaded. You must select a bucket that was provided during the enrollment process.

string gcs_uri = 2;

Returns
Type	Description
GenerateAuditReportRequest.Builder	This builder for chaining.

clearReportFormat()

public GenerateAuditReportRequest.Builder clearReportFormat()

Required. Format for the audit report.

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

Returns
Type	Description
GenerateAuditReportRequest.Builder	This builder for chaining.

clearScope()

public GenerateAuditReportRequest.Builder clearScope()

Required. Organization, folder, or project that the audit applies to, in one of the following formats:

• projects/{project}/locations/{location}
• folders/{folder}/locations/{location}
• organizations/{organization}/locations/{location}

string scope = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
GenerateAuditReportRequest.Builder	This builder for chaining.

clearValidateOnly()

public GenerateAuditReportRequest.Builder clearValidateOnly()

Optional. If true, only validates the request and does not generate the audit report. This executes standard request validation (such as schema, framework existence, scope, and IAM checks) and skips the apply phase.

Use this field for the following purposes:

• Infrastructure as Code (IaC): Allow tools like Terraform to run dry-run mutations (e.g., terraform plan) without creating real resources or incurring costs.
• User Interface Validation: Enable real-time form and permission validation in custom UIs before submitting requests.
• CI/CD & Automation: Test your scripts, permissions, and parameters safely without triggering expensive Long-Running Operations (LROs) or consuming resource quotas.

bool validate_only = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
GenerateAuditReportRequest.Builder	This builder for chaining.

getComplianceFramework()

public String getComplianceFramework()

Required. The framework that's used for the audit report. For example, NIST_800_53.

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

Returns
Type	Description
String	The complianceFramework.

getComplianceFrameworkBytes()

public ByteString getComplianceFrameworkBytes()

Required. The framework that's used for the audit report. For example, NIST_800_53.

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

Returns
Type	Description
ByteString	The bytes for complianceFramework.

getComplianceStandard() (deprecated)

public String getComplianceStandard()

Deprecated. google.cloud.auditmanager.v1.GenerateAuditReportRequest.compliance_standard is deprecated. See google/cloud/auditmanager/v1/auditmanager.proto;l=478

Optional. Deprecated. Compliance standard for the audit report.

Use the compliance_framework field instead.

string compliance_standard = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The complianceStandard.

getComplianceStandardBytes() (deprecated)

public ByteString getComplianceStandardBytes()

Deprecated. google.cloud.auditmanager.v1.GenerateAuditReportRequest.compliance_standard is deprecated. See google/cloud/auditmanager/v1/auditmanager.proto;l=478

Optional. Deprecated. Compliance standard for the audit report.

Use the compliance_framework field instead.

string compliance_standard = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for complianceStandard.

getDefaultInstanceForType()

public GenerateAuditReportRequest getDefaultInstanceForType()

Returns
Type	Description
GenerateAuditReportRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getDestinationCase()

public GenerateAuditReportRequest.DestinationCase getDestinationCase()

Returns
Type	Description
GenerateAuditReportRequest.DestinationCase

getGcsUri()

public String getGcsUri()

URL for the Cloud Storage bucket where the report and evidence is uploaded. You must select a bucket that was provided during the enrollment process.

string gcs_uri = 2;

Returns
Type	Description
String	The gcsUri.

getGcsUriBytes()

public ByteString getGcsUriBytes()

URL for the Cloud Storage bucket where the report and evidence is uploaded. You must select a bucket that was provided during the enrollment process.

string gcs_uri = 2;

Returns
Type	Description
ByteString	The bytes for gcsUri.

getReportFormat()

public GenerateAuditReportRequest.AuditReportFormat getReportFormat()

Required. Format for the audit report.

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

Returns
Type	Description
GenerateAuditReportRequest.AuditReportFormat	The reportFormat.

getReportFormatValue()

public int getReportFormatValue()

Required. Format for the audit report.

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

Returns
Type	Description
int	The enum numeric value on the wire for reportFormat.

getScope()

public String getScope()

Required. Organization, folder, or project that the audit applies to, in one of the following formats:

• projects/{project}/locations/{location}
• folders/{folder}/locations/{location}
• organizations/{organization}/locations/{location}

string scope = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The scope.

getScopeBytes()

public ByteString getScopeBytes()

Required. Organization, folder, or project that the audit applies to, in one of the following formats:

• projects/{project}/locations/{location}
• folders/{folder}/locations/{location}
• organizations/{organization}/locations/{location}

string scope = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for scope.

getValidateOnly()

public boolean getValidateOnly()

Optional. If true, only validates the request and does not generate the audit report. This executes standard request validation (such as schema, framework existence, scope, and IAM checks) and skips the apply phase.

Use this field for the following purposes:

• Infrastructure as Code (IaC): Allow tools like Terraform to run dry-run mutations (e.g., terraform plan) without creating real resources or incurring costs.
• User Interface Validation: Enable real-time form and permission validation in custom UIs before submitting requests.
• CI/CD & Automation: Test your scripts, permissions, and parameters safely without triggering expensive Long-Running Operations (LROs) or consuming resource quotas.

bool validate_only = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The validateOnly.

hasGcsUri()

public boolean hasGcsUri()

URL for the Cloud Storage bucket where the report and evidence is uploaded. You must select a bucket that was provided during the enrollment process.

string gcs_uri = 2;

Returns
Type	Description
boolean	Whether the gcsUri field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(GenerateAuditReportRequest other)

public GenerateAuditReportRequest.Builder mergeFrom(GenerateAuditReportRequest other)

Parameter
Name	Description
other	GenerateAuditReportRequest

Returns
Type	Description
GenerateAuditReportRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GenerateAuditReportRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GenerateAuditReportRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public GenerateAuditReportRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
GenerateAuditReportRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

setComplianceFramework(String value)

public GenerateAuditReportRequest.Builder setComplianceFramework(String value)

Required. The framework that's used for the audit report. For example, NIST_800_53.

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

Parameter
Name	Description
value	String The complianceFramework to set.

Returns
Type	Description
GenerateAuditReportRequest.Builder	This builder for chaining.

setComplianceFrameworkBytes(ByteString value)

public GenerateAuditReportRequest.Builder setComplianceFrameworkBytes(ByteString value)

Required. The framework that's used for the audit report. For example, NIST_800_53.

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

Parameter
Name	Description
value	ByteString The bytes for complianceFramework to set.

Returns
Type	Description
GenerateAuditReportRequest.Builder	This builder for chaining.

setComplianceStandard(String value) (deprecated)

public GenerateAuditReportRequest.Builder setComplianceStandard(String value)

Deprecated. google.cloud.auditmanager.v1.GenerateAuditReportRequest.compliance_standard is deprecated. See google/cloud/auditmanager/v1/auditmanager.proto;l=478

Optional. Deprecated. Compliance standard for the audit report.

Use the compliance_framework field instead.

string compliance_standard = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The complianceStandard to set.

Returns
Type	Description
GenerateAuditReportRequest.Builder	This builder for chaining.

setComplianceStandardBytes(ByteString value) (deprecated)

public GenerateAuditReportRequest.Builder setComplianceStandardBytes(ByteString value)

Deprecated. google.cloud.auditmanager.v1.GenerateAuditReportRequest.compliance_standard is deprecated. See google/cloud/auditmanager/v1/auditmanager.proto;l=478

Optional. Deprecated. Compliance standard for the audit report.

Use the compliance_framework field instead.

string compliance_standard = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for complianceStandard to set.

Returns
Type	Description
GenerateAuditReportRequest.Builder	This builder for chaining.

setGcsUri(String value)

public GenerateAuditReportRequest.Builder setGcsUri(String value)

URL for the Cloud Storage bucket where the report and evidence is uploaded. You must select a bucket that was provided during the enrollment process.

string gcs_uri = 2;

Parameter
Name	Description
value	String The gcsUri to set.

Returns
Type	Description
GenerateAuditReportRequest.Builder	This builder for chaining.

setGcsUriBytes(ByteString value)

public GenerateAuditReportRequest.Builder setGcsUriBytes(ByteString value)

URL for the Cloud Storage bucket where the report and evidence is uploaded. You must select a bucket that was provided during the enrollment process.

string gcs_uri = 2;

Parameter
Name	Description
value	ByteString The bytes for gcsUri to set.

Returns
Type	Description
GenerateAuditReportRequest.Builder	This builder for chaining.

setReportFormat(GenerateAuditReportRequest.AuditReportFormat value)

public GenerateAuditReportRequest.Builder setReportFormat(GenerateAuditReportRequest.AuditReportFormat value)

Required. Format for the audit report.

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

Parameter
Name	Description
value	GenerateAuditReportRequest.AuditReportFormat The reportFormat to set.

Returns
Type	Description
GenerateAuditReportRequest.Builder	This builder for chaining.

setReportFormatValue(int value)

public GenerateAuditReportRequest.Builder setReportFormatValue(int value)

Required. Format for the audit report.

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

Parameter
Name	Description
value	int The enum numeric value on the wire for reportFormat to set.

Returns
Type	Description
GenerateAuditReportRequest.Builder	This builder for chaining.

setScope(String value)

public GenerateAuditReportRequest.Builder setScope(String value)

Required. Organization, folder, or project that the audit applies to, in one of the following formats:

• projects/{project}/locations/{location}
• folders/{folder}/locations/{location}
• organizations/{organization}/locations/{location}

string scope = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	String The scope to set.

Returns
Type	Description
GenerateAuditReportRequest.Builder	This builder for chaining.

setScopeBytes(ByteString value)

public GenerateAuditReportRequest.Builder setScopeBytes(ByteString value)

Required. Organization, folder, or project that the audit applies to, in one of the following formats:

• projects/{project}/locations/{location}
• folders/{folder}/locations/{location}
• organizations/{organization}/locations/{location}

string scope = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	ByteString The bytes for scope to set.

Returns
Type	Description
GenerateAuditReportRequest.Builder	This builder for chaining.

setValidateOnly(boolean value)

public GenerateAuditReportRequest.Builder setValidateOnly(boolean value)

Optional. If true, only validates the request and does not generate the audit report. This executes standard request validation (such as schema, framework existence, scope, and IAM checks) and skips the apply phase.

Use this field for the following purposes:

• Infrastructure as Code (IaC): Allow tools like Terraform to run dry-run mutations (e.g., terraform plan) without creating real resources or incurring costs.
• User Interface Validation: Enable real-time form and permission validation in custom UIs before submitting requests.
• CI/CD & Automation: Test your scripts, permissions, and parameters safely without triggering expensive Long-Running Operations (LROs) or consuming resource quotas.

bool validate_only = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	boolean The validateOnly to set.

Returns
Type	Description
GenerateAuditReportRequest.Builder	This builder for chaining.