Class AnalyzeOrgPoliciesRequest (3.16.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
TypeDescription
int

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

SCOPE_FIELD_NUMBER

public static final int SCOPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static AnalyzeOrgPoliciesRequest getDefaultInstance()
Returns
TypeDescription
AnalyzeOrgPoliciesRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static AnalyzeOrgPoliciesRequest.Builder newBuilder()
Returns
TypeDescription
AnalyzeOrgPoliciesRequest.Builder

newBuilder(AnalyzeOrgPoliciesRequest prototype)

public static AnalyzeOrgPoliciesRequest.Builder newBuilder(AnalyzeOrgPoliciesRequest prototype)
Parameter
NameDescription
prototypeAnalyzeOrgPoliciesRequest
Returns
TypeDescription
AnalyzeOrgPoliciesRequest.Builder

parseDelimitedFrom(InputStream input)

public static AnalyzeOrgPoliciesRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AnalyzeOrgPoliciesRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnalyzeOrgPoliciesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnalyzeOrgPoliciesRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static AnalyzeOrgPoliciesRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
AnalyzeOrgPoliciesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AnalyzeOrgPoliciesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnalyzeOrgPoliciesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AnalyzeOrgPoliciesRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
AnalyzeOrgPoliciesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AnalyzeOrgPoliciesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnalyzeOrgPoliciesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AnalyzeOrgPoliciesRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
AnalyzeOrgPoliciesRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AnalyzeOrgPoliciesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnalyzeOrgPoliciesRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static AnalyzeOrgPoliciesRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AnalyzeOrgPoliciesRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnalyzeOrgPoliciesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnalyzeOrgPoliciesRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static AnalyzeOrgPoliciesRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
AnalyzeOrgPoliciesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AnalyzeOrgPoliciesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnalyzeOrgPoliciesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<AnalyzeOrgPoliciesRequest> parser()
Returns
TypeDescription
Parser<AnalyzeOrgPoliciesRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for constraint.

getDefaultInstanceForType()

public AnalyzeOrgPoliciesRequest getDefaultInstanceForType()
Returns
TypeDescription
AnalyzeOrgPoliciesRequest

getFilter()

public String getFilter()

The expression to filter AnalyzeOrgPoliciesResponse.org_policy_results. The only supported field is consolidated_policy.attached_resource, and the only supported operator is =. Example: consolidated_policy.attached_resource="//cloudresourcemanager.googleapis.com/folders/001" will return the org policy results of"folders/001".

string filter = 3;

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

The expression to filter AnalyzeOrgPoliciesResponse.org_policy_results. The only supported field is consolidated_policy.attached_resource, and the only supported operator is =. Example: consolidated_policy.attached_resource="//cloudresourcemanager.googleapis.com/folders/001" will return the org policy results of"folders/001".

string filter = 3;

Returns
TypeDescription
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
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

The pagination token to retrieve the next page.

string page_token = 5;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

The pagination token to retrieve the next page.

string page_token = 5;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParserForType()

public Parser<AnalyzeOrgPoliciesRequest> getParserForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for scope.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
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
TypeDescription
boolean

Whether the pageSize field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public AnalyzeOrgPoliciesRequest.Builder newBuilderForType()
Returns
TypeDescription
AnalyzeOrgPoliciesRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AnalyzeOrgPoliciesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
AnalyzeOrgPoliciesRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public AnalyzeOrgPoliciesRequest.Builder toBuilder()
Returns
TypeDescription
AnalyzeOrgPoliciesRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException