Class GenerateAuditReportRequest (0.17.0)

public final class GenerateAuditReportRequest extends GeneratedMessage implements GenerateAuditReportRequestOrBuilder

Request message for GenerateAuditReport.

Protobuf type google.cloud.auditmanager.v1.GenerateAuditReportRequest

Static Fields

COMPLIANCE_FRAMEWORK_FIELD_NUMBER

public static final int COMPLIANCE_FRAMEWORK_FIELD_NUMBER
Field Value
Type Description
int

COMPLIANCE_STANDARD_FIELD_NUMBER

public static final int COMPLIANCE_STANDARD_FIELD_NUMBER
Field Value
Type Description
int

GCS_URI_FIELD_NUMBER

public static final int GCS_URI_FIELD_NUMBER
Field Value
Type Description
int

REPORT_FORMAT_FIELD_NUMBER

public static final int REPORT_FORMAT_FIELD_NUMBER
Field Value
Type Description
int

SCOPE_FIELD_NUMBER

public static final int SCOPE_FIELD_NUMBER
Field Value
Type Description
int

VALIDATE_ONLY_FIELD_NUMBER

public static final int VALIDATE_ONLY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GenerateAuditReportRequest getDefaultInstance()
Returns
Type Description
GenerateAuditReportRequest

getDescriptor()

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

newBuilder()

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

newBuilder(GenerateAuditReportRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

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

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.

getParserForType()

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

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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 GenerateAuditReportRequest.Builder newBuilderForType()
Returns
Type Description
GenerateAuditReportRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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