Class EnrollResourceRequest.Builder (0.17.0) 

public static final class EnrollResourceRequest.Builder extends GeneratedMessage.Builder<EnrollResourceRequest.Builder> implements EnrollResourceRequestOrBuilder

Request message for EnrollResource.

Protobuf type google.cloud.auditmanager.v1.EnrollResourceRequest

Inheritance

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

Static Methods

getDescriptor()

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

Methods

addAllDestinations(Iterable<? extends EnrollResourceRequest.EligibleDestination> values)

public EnrollResourceRequest.Builder addAllDestinations(Iterable<? extends EnrollResourceRequest.EligibleDestination> values)

Required. Cloud Storage buckets that you can upload your audit reports to during the audit process.

When you enroll an organization or folder, you can choose a Cloud Storage bucket from any project in the organization or folder. If you run an audit at the project level using the service agent at the organization or folder level, all the buckets that are associated with the service agent are available.

repeated .google.cloud.auditmanager.v1.EnrollResourceRequest.EligibleDestination destinations = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
values Iterable<? extends com.google.cloud.auditmanager.v1.EnrollResourceRequest.EligibleDestination>
Returns
Type Description
EnrollResourceRequest.Builder

addDestinations(EnrollResourceRequest.EligibleDestination value)

public EnrollResourceRequest.Builder addDestinations(EnrollResourceRequest.EligibleDestination value)

Required. Cloud Storage buckets that you can upload your audit reports to during the audit process.

When you enroll an organization or folder, you can choose a Cloud Storage bucket from any project in the organization or folder. If you run an audit at the project level using the service agent at the organization or folder level, all the buckets that are associated with the service agent are available.

repeated .google.cloud.auditmanager.v1.EnrollResourceRequest.EligibleDestination destinations = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value EnrollResourceRequest.EligibleDestination
Returns
Type Description
EnrollResourceRequest.Builder

addDestinations(EnrollResourceRequest.EligibleDestination.Builder builderForValue)

public EnrollResourceRequest.Builder addDestinations(EnrollResourceRequest.EligibleDestination.Builder builderForValue)

Required. Cloud Storage buckets that you can upload your audit reports to during the audit process.

When you enroll an organization or folder, you can choose a Cloud Storage bucket from any project in the organization or folder. If you run an audit at the project level using the service agent at the organization or folder level, all the buckets that are associated with the service agent are available.

repeated .google.cloud.auditmanager.v1.EnrollResourceRequest.EligibleDestination destinations = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue EnrollResourceRequest.EligibleDestination.Builder
Returns
Type Description
EnrollResourceRequest.Builder

addDestinations(int index, EnrollResourceRequest.EligibleDestination value)

public EnrollResourceRequest.Builder addDestinations(int index, EnrollResourceRequest.EligibleDestination value)

Required. Cloud Storage buckets that you can upload your audit reports to during the audit process.

When you enroll an organization or folder, you can choose a Cloud Storage bucket from any project in the organization or folder. If you run an audit at the project level using the service agent at the organization or folder level, all the buckets that are associated with the service agent are available.

repeated .google.cloud.auditmanager.v1.EnrollResourceRequest.EligibleDestination destinations = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value EnrollResourceRequest.EligibleDestination
Returns
Type Description
EnrollResourceRequest.Builder

addDestinations(int index, EnrollResourceRequest.EligibleDestination.Builder builderForValue)

public EnrollResourceRequest.Builder addDestinations(int index, EnrollResourceRequest.EligibleDestination.Builder builderForValue)

Required. Cloud Storage buckets that you can upload your audit reports to during the audit process.

When you enroll an organization or folder, you can choose a Cloud Storage bucket from any project in the organization or folder. If you run an audit at the project level using the service agent at the organization or folder level, all the buckets that are associated with the service agent are available.

repeated .google.cloud.auditmanager.v1.EnrollResourceRequest.EligibleDestination destinations = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue EnrollResourceRequest.EligibleDestination.Builder
Returns
Type Description
EnrollResourceRequest.Builder

addDestinationsBuilder()

public EnrollResourceRequest.EligibleDestination.Builder addDestinationsBuilder()

Required. Cloud Storage buckets that you can upload your audit reports to during the audit process.

When you enroll an organization or folder, you can choose a Cloud Storage bucket from any project in the organization or folder. If you run an audit at the project level using the service agent at the organization or folder level, all the buckets that are associated with the service agent are available.

repeated .google.cloud.auditmanager.v1.EnrollResourceRequest.EligibleDestination destinations = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
EnrollResourceRequest.EligibleDestination.Builder

addDestinationsBuilder(int index)

public EnrollResourceRequest.EligibleDestination.Builder addDestinationsBuilder(int index)

Required. Cloud Storage buckets that you can upload your audit reports to during the audit process.

When you enroll an organization or folder, you can choose a Cloud Storage bucket from any project in the organization or folder. If you run an audit at the project level using the service agent at the organization or folder level, all the buckets that are associated with the service agent are available.

repeated .google.cloud.auditmanager.v1.EnrollResourceRequest.EligibleDestination destinations = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
EnrollResourceRequest.EligibleDestination.Builder

build()

public EnrollResourceRequest build()
Returns
Type Description
EnrollResourceRequest

buildPartial()

public EnrollResourceRequest buildPartial()
Returns
Type Description
EnrollResourceRequest

clear()

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

clearDestinations()

public EnrollResourceRequest.Builder clearDestinations()

Required. Cloud Storage buckets that you can upload your audit reports to during the audit process.

When you enroll an organization or folder, you can choose a Cloud Storage bucket from any project in the organization or folder. If you run an audit at the project level using the service agent at the organization or folder level, all the buckets that are associated with the service agent are available.

repeated .google.cloud.auditmanager.v1.EnrollResourceRequest.EligibleDestination destinations = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
EnrollResourceRequest.Builder

clearScope()

public EnrollResourceRequest.Builder clearScope()

Required. Organization, folder, or project to enroll in Audit Manager, 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
EnrollResourceRequest.Builder

This builder for chaining.

clearValidateOnly()

public EnrollResourceRequest.Builder clearValidateOnly()

Optional. If true, only validates the request and does not enroll the resource. This executes standard request validation (such as schema, IAM, and destination 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 consuming resource quotas.

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

Returns
Type Description
EnrollResourceRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public EnrollResourceRequest getDefaultInstanceForType()
Returns
Type Description
EnrollResourceRequest

getDescriptorForType()

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

getDestinations(int index)

public EnrollResourceRequest.EligibleDestination getDestinations(int index)

Required. Cloud Storage buckets that you can upload your audit reports to during the audit process.

When you enroll an organization or folder, you can choose a Cloud Storage bucket from any project in the organization or folder. If you run an audit at the project level using the service agent at the organization or folder level, all the buckets that are associated with the service agent are available.

repeated .google.cloud.auditmanager.v1.EnrollResourceRequest.EligibleDestination destinations = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
EnrollResourceRequest.EligibleDestination

getDestinationsBuilder(int index)

public EnrollResourceRequest.EligibleDestination.Builder getDestinationsBuilder(int index)

Required. Cloud Storage buckets that you can upload your audit reports to during the audit process.

When you enroll an organization or folder, you can choose a Cloud Storage bucket from any project in the organization or folder. If you run an audit at the project level using the service agent at the organization or folder level, all the buckets that are associated with the service agent are available.

repeated .google.cloud.auditmanager.v1.EnrollResourceRequest.EligibleDestination destinations = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
EnrollResourceRequest.EligibleDestination.Builder

getDestinationsBuilderList()

public List<EnrollResourceRequest.EligibleDestination.Builder> getDestinationsBuilderList()

Required. Cloud Storage buckets that you can upload your audit reports to during the audit process.

When you enroll an organization or folder, you can choose a Cloud Storage bucket from any project in the organization or folder. If you run an audit at the project level using the service agent at the organization or folder level, all the buckets that are associated with the service agent are available.

repeated .google.cloud.auditmanager.v1.EnrollResourceRequest.EligibleDestination destinations = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Builder>

getDestinationsCount()

public int getDestinationsCount()

Required. Cloud Storage buckets that you can upload your audit reports to during the audit process.

When you enroll an organization or folder, you can choose a Cloud Storage bucket from any project in the organization or folder. If you run an audit at the project level using the service agent at the organization or folder level, all the buckets that are associated with the service agent are available.

repeated .google.cloud.auditmanager.v1.EnrollResourceRequest.EligibleDestination destinations = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getDestinationsList()

public List<EnrollResourceRequest.EligibleDestination> getDestinationsList()

Required. Cloud Storage buckets that you can upload your audit reports to during the audit process.

When you enroll an organization or folder, you can choose a Cloud Storage bucket from any project in the organization or folder. If you run an audit at the project level using the service agent at the organization or folder level, all the buckets that are associated with the service agent are available.

repeated .google.cloud.auditmanager.v1.EnrollResourceRequest.EligibleDestination destinations = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<EligibleDestination>

getDestinationsOrBuilder(int index)

public EnrollResourceRequest.EligibleDestinationOrBuilder getDestinationsOrBuilder(int index)

Required. Cloud Storage buckets that you can upload your audit reports to during the audit process.

When you enroll an organization or folder, you can choose a Cloud Storage bucket from any project in the organization or folder. If you run an audit at the project level using the service agent at the organization or folder level, all the buckets that are associated with the service agent are available.

repeated .google.cloud.auditmanager.v1.EnrollResourceRequest.EligibleDestination destinations = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
EnrollResourceRequest.EligibleDestinationOrBuilder

getDestinationsOrBuilderList()

public List<? extends EnrollResourceRequest.EligibleDestinationOrBuilder> getDestinationsOrBuilderList()

Required. Cloud Storage buckets that you can upload your audit reports to during the audit process.

When you enroll an organization or folder, you can choose a Cloud Storage bucket from any project in the organization or folder. If you run an audit at the project level using the service agent at the organization or folder level, all the buckets that are associated with the service agent are available.

repeated .google.cloud.auditmanager.v1.EnrollResourceRequest.EligibleDestination destinations = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.cloud.auditmanager.v1.EnrollResourceRequest.EligibleDestinationOrBuilder>

getScope()

public String getScope()

Required. Organization, folder, or project to enroll in Audit Manager, 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 to enroll in Audit Manager, 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 enroll the resource. This executes standard request validation (such as schema, IAM, and destination 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 consuming resource quotas.

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

Returns
Type Description
boolean

The validateOnly.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(EnrollResourceRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

removeDestinations(int index)

public EnrollResourceRequest.Builder removeDestinations(int index)

Required. Cloud Storage buckets that you can upload your audit reports to during the audit process.

When you enroll an organization or folder, you can choose a Cloud Storage bucket from any project in the organization or folder. If you run an audit at the project level using the service agent at the organization or folder level, all the buckets that are associated with the service agent are available.

repeated .google.cloud.auditmanager.v1.EnrollResourceRequest.EligibleDestination destinations = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
EnrollResourceRequest.Builder

setDestinations(int index, EnrollResourceRequest.EligibleDestination value)

public EnrollResourceRequest.Builder setDestinations(int index, EnrollResourceRequest.EligibleDestination value)

Required. Cloud Storage buckets that you can upload your audit reports to during the audit process.

When you enroll an organization or folder, you can choose a Cloud Storage bucket from any project in the organization or folder. If you run an audit at the project level using the service agent at the organization or folder level, all the buckets that are associated with the service agent are available.

repeated .google.cloud.auditmanager.v1.EnrollResourceRequest.EligibleDestination destinations = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value EnrollResourceRequest.EligibleDestination
Returns
Type Description
EnrollResourceRequest.Builder

setDestinations(int index, EnrollResourceRequest.EligibleDestination.Builder builderForValue)

public EnrollResourceRequest.Builder setDestinations(int index, EnrollResourceRequest.EligibleDestination.Builder builderForValue)

Required. Cloud Storage buckets that you can upload your audit reports to during the audit process.

When you enroll an organization or folder, you can choose a Cloud Storage bucket from any project in the organization or folder. If you run an audit at the project level using the service agent at the organization or folder level, all the buckets that are associated with the service agent are available.

repeated .google.cloud.auditmanager.v1.EnrollResourceRequest.EligibleDestination destinations = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue EnrollResourceRequest.EligibleDestination.Builder
Returns
Type Description
EnrollResourceRequest.Builder

setScope(String value)

public EnrollResourceRequest.Builder setScope(String value)

Required. Organization, folder, or project to enroll in Audit Manager, 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
EnrollResourceRequest.Builder

This builder for chaining.

setScopeBytes(ByteString value)

public EnrollResourceRequest.Builder setScopeBytes(ByteString value)

Required. Organization, folder, or project to enroll in Audit Manager, 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
EnrollResourceRequest.Builder

This builder for chaining.

setValidateOnly(boolean value)

public EnrollResourceRequest.Builder setValidateOnly(boolean value)

Optional. If true, only validates the request and does not enroll the resource. This executes standard request validation (such as schema, IAM, and destination 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 consuming resource quotas.

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

Parameter
Name Description
value boolean

The validateOnly to set.
Returns
Type Description
EnrollResourceRequest.Builder

This builder for chaining.