Class AnalyzeOrgPoliciesRequest.Builder (3.58.0) 

public static final class AnalyzeOrgPoliciesRequest.Builder extends GeneratedMessageV3.Builder<AnalyzeOrgPoliciesRequest.Builder> implements AnalyzeOrgPoliciesRequestOrBuilder

A request message for AssetService.AnalyzeOrgPolicies.

Protobuf type google.cloud.asset.v1.AnalyzeOrgPoliciesRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AnalyzeOrgPoliciesRequest.Builder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AnalyzeOrgPoliciesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AnalyzeOrgPoliciesRequest.Builder
Overrides

build()

public AnalyzeOrgPoliciesRequest build()
Returns
Type Description
AnalyzeOrgPoliciesRequest

buildPartial()

public AnalyzeOrgPoliciesRequest buildPartial()
Returns
Type Description
AnalyzeOrgPoliciesRequest

clear()

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

clearConstraint()

public AnalyzeOrgPoliciesRequest.Builder clearConstraint()

Required. The name of the constraint to analyze organization policies for. The response only contains analyzed organization policies for the provided constraint.

string constraint = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AnalyzeOrgPoliciesRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public AnalyzeOrgPoliciesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
AnalyzeOrgPoliciesRequest.Builder
Overrides

clearFilter()

public AnalyzeOrgPoliciesRequest.Builder clearFilter()

The expression to filter AnalyzeOrgPoliciesResponse.org_policy_results. Filtering is currently available for bare literal values and the following fields:

  • consolidated_policy.attached_resource

  • consolidated_policy.rules.enforce

    When filtering by a specific field, the only supported operator is =. For example, filtering by consolidated_policy.attached_resource="//cloudresourcemanager.googleapis.com/folders/001" will return all the Organization Policy results attached to "folders/001".

string filter = 3;

Returns
Type Description
AnalyzeOrgPoliciesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public AnalyzeOrgPoliciesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
AnalyzeOrgPoliciesRequest.Builder
Overrides

clearPageSize()

public AnalyzeOrgPoliciesRequest.Builder clearPageSize()

The maximum number of items to return per page. If unspecified, AnalyzeOrgPoliciesResponse.org_policy_results will contain 20 items with a maximum of 200.

optional int32 page_size = 4;

Returns
Type Description
AnalyzeOrgPoliciesRequest.Builder

This builder for chaining.

clearPageToken()

public AnalyzeOrgPoliciesRequest.Builder clearPageToken()

The pagination token to retrieve the next page.

string page_token = 5;

Returns
Type Description
AnalyzeOrgPoliciesRequest.Builder

This builder for chaining.

clearScope()

public AnalyzeOrgPoliciesRequest.Builder clearScope()

Required. The organization to scope the request. Only organization policies within the scope will be analyzed.

  • organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")

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

Returns
Type Description
AnalyzeOrgPoliciesRequest.Builder

This builder for chaining.

clone()

public AnalyzeOrgPoliciesRequest.Builder clone()
Returns
Type Description
AnalyzeOrgPoliciesRequest.Builder
Overrides

getConstraint()

public String getConstraint()

Required. The name of the constraint to analyze organization policies for. The response only contains analyzed organization policies for the provided constraint.

string constraint = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The constraint.

getConstraintBytes()

public ByteString getConstraintBytes()

Required. The name of the constraint to analyze organization policies for. The response only contains analyzed organization policies for the provided constraint.

string constraint = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for constraint.

getDefaultInstanceForType()

public AnalyzeOrgPoliciesRequest getDefaultInstanceForType()
Returns
Type Description
AnalyzeOrgPoliciesRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

The expression to filter AnalyzeOrgPoliciesResponse.org_policy_results. Filtering is currently available for bare literal values and the following fields:

  • consolidated_policy.attached_resource

  • consolidated_policy.rules.enforce

    When filtering by a specific field, the only supported operator is =. For example, filtering by consolidated_policy.attached_resource="//cloudresourcemanager.googleapis.com/folders/001" will return all the Organization Policy results attached to "folders/001".

string filter = 3;

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

The expression to filter AnalyzeOrgPoliciesResponse.org_policy_results. Filtering is currently available for bare literal values and the following fields:

  • consolidated_policy.attached_resource

  • consolidated_policy.rules.enforce

    When filtering by a specific field, the only supported operator is =. For example, filtering by consolidated_policy.attached_resource="//cloudresourcemanager.googleapis.com/folders/001" will return all the Organization Policy results attached to "folders/001".

string filter = 3;

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

The maximum number of items to return per page. If unspecified, AnalyzeOrgPoliciesResponse.org_policy_results will contain 20 items with a maximum of 200.

optional int32 page_size = 4;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

The pagination token to retrieve the next page.

string page_token = 5;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

The pagination token to retrieve the next page.

string page_token = 5;

Returns
Type Description
ByteString

The bytes for pageToken.

getScope()

public String getScope()

Required. The organization to scope the request. Only organization policies within the scope will be analyzed.

  • organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")

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

Returns
Type Description
String

The scope.

getScopeBytes()

public ByteString getScopeBytes()

Required. The organization to scope the request. Only organization policies within the scope will be analyzed.

  • organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")

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

Returns
Type Description
ByteString

The bytes for scope.

hasPageSize()

public boolean hasPageSize()

The maximum number of items to return per page. If unspecified, AnalyzeOrgPoliciesResponse.org_policy_results will contain 20 items with a maximum of 200.

optional int32 page_size = 4;

Returns
Type Description
boolean

Whether the pageSize field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AnalyzeOrgPoliciesRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AnalyzeOrgPoliciesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AnalyzeOrgPoliciesRequest.Builder
Overrides

setConstraint(String value)

public AnalyzeOrgPoliciesRequest.Builder setConstraint(String value)

Required. The name of the constraint to analyze organization policies for. The response only contains analyzed organization policies for the provided constraint.

string constraint = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The constraint to set.
Returns
Type Description
AnalyzeOrgPoliciesRequest.Builder

This builder for chaining.

setConstraintBytes(ByteString value)

public AnalyzeOrgPoliciesRequest.Builder setConstraintBytes(ByteString value)

Required. The name of the constraint to analyze organization policies for. The response only contains analyzed organization policies for the provided constraint.

string constraint = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for constraint to set.
Returns
Type Description
AnalyzeOrgPoliciesRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public AnalyzeOrgPoliciesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AnalyzeOrgPoliciesRequest.Builder
Overrides

setFilter(String value)

public AnalyzeOrgPoliciesRequest.Builder setFilter(String value)

The expression to filter AnalyzeOrgPoliciesResponse.org_policy_results. Filtering is currently available for bare literal values and the following fields:

  • consolidated_policy.attached_resource

  • consolidated_policy.rules.enforce

    When filtering by a specific field, the only supported operator is =. For example, filtering by consolidated_policy.attached_resource="//cloudresourcemanager.googleapis.com/folders/001" will return all the Organization Policy results attached to "folders/001".

string filter = 3;

Parameter
Name Description
value String

The filter to set.
Returns
Type Description
AnalyzeOrgPoliciesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public AnalyzeOrgPoliciesRequest.Builder setFilterBytes(ByteString value)

The expression to filter AnalyzeOrgPoliciesResponse.org_policy_results. Filtering is currently available for bare literal values and the following fields:

  • consolidated_policy.attached_resource

  • consolidated_policy.rules.enforce

    When filtering by a specific field, the only supported operator is =. For example, filtering by consolidated_policy.attached_resource="//cloudresourcemanager.googleapis.com/folders/001" will return all the Organization Policy results attached to "folders/001".

string filter = 3;

Parameter
Name Description
value ByteString

The bytes for filter to set.
Returns
Type Description
AnalyzeOrgPoliciesRequest.Builder

This builder for chaining.

setPageSize(int value)

public AnalyzeOrgPoliciesRequest.Builder setPageSize(int value)

The maximum number of items to return per page. If unspecified, AnalyzeOrgPoliciesResponse.org_policy_results will contain 20 items with a maximum of 200.

optional int32 page_size = 4;

Parameter
Name Description
value int

The pageSize to set.
Returns
Type Description
AnalyzeOrgPoliciesRequest.Builder

This builder for chaining.

setPageToken(String value)

public AnalyzeOrgPoliciesRequest.Builder setPageToken(String value)

The pagination token to retrieve the next page.

string page_token = 5;

Parameter
Name Description
value String

The pageToken to set.
Returns
Type Description
AnalyzeOrgPoliciesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public AnalyzeOrgPoliciesRequest.Builder setPageTokenBytes(ByteString value)

The pagination token to retrieve the next page.

string page_token = 5;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.
Returns
Type Description
AnalyzeOrgPoliciesRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AnalyzeOrgPoliciesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
AnalyzeOrgPoliciesRequest.Builder
Overrides

setScope(String value)

public AnalyzeOrgPoliciesRequest.Builder setScope(String value)

Required. The organization to scope the request. Only organization policies within the scope will be analyzed.

  • organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")

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

Parameter
Name Description
value String

The scope to set.
Returns
Type Description
AnalyzeOrgPoliciesRequest.Builder

This builder for chaining.

setScopeBytes(ByteString value)

public AnalyzeOrgPoliciesRequest.Builder setScopeBytes(ByteString value)

Required. The organization to scope the request. Only organization policies within the scope will be analyzed.

  • organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")

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

Parameter
Name Description
value ByteString

The bytes for scope to set.
Returns
Type Description
AnalyzeOrgPoliciesRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final AnalyzeOrgPoliciesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AnalyzeOrgPoliciesRequest.Builder
Overrides