Class AnalyzeOrgPoliciesRequest (3.44.0)

public final class AnalyzeOrgPoliciesRequest extends GeneratedMessageV3 implements AnalyzeOrgPoliciesRequestOrBuilder

A request message for AssetService.AnalyzeOrgPolicies.

Protobuf type google.cloud.asset.v1.AnalyzeOrgPoliciesRequest

Static Fields

CONSTRAINT_FIELD_NUMBER

public static final int CONSTRAINT_FIELD_NUMBER
Field Value
Type Description
int

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

SCOPE_FIELD_NUMBER

public static final int SCOPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AnalyzeOrgPoliciesRequest getDefaultInstance()
Returns
Type Description
AnalyzeOrgPoliciesRequest

getDescriptor()

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

newBuilder()

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

newBuilder(AnalyzeOrgPoliciesRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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

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.

getParserForType()

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

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AnalyzeOrgPoliciesRequest.Builder newBuilderForType()
Returns
Type Description
AnalyzeOrgPoliciesRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AnalyzeOrgPoliciesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AnalyzeOrgPoliciesRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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