Package com.google.cloud.asset.v1

Class AnalyzeOrgPoliciesRequest

  • All Implemented Interfaces:
    AnalyzeOrgPoliciesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class AnalyzeOrgPoliciesRequest
extends com.google.protobuf.GeneratedMessageV3
implements AnalyzeOrgPoliciesRequestOrBuilder
     A request message for
 [AssetService.AnalyzeOrgPolicies][google.cloud.asset.v1.AssetService.AnalyzeOrgPolicies].
    Protobuf type google.cloud.asset.v1.AnalyzeOrgPoliciesRequest
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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];
        Specified by:
        getScope in interface AnalyzeOrgPoliciesRequestOrBuilder
        Returns:
        The scope.

      • getScopeBytes

        public com.google.protobuf.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];
        Specified by:
        getScopeBytes in interface AnalyzeOrgPoliciesRequestOrBuilder
        Returns:
        The bytes for scope.

      • 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];
        Specified by:
        getConstraint in interface AnalyzeOrgPoliciesRequestOrBuilder
        Returns:
        The constraint.

      • getConstraintBytes

        public com.google.protobuf.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];
        Specified by:
        getConstraintBytes in interface AnalyzeOrgPoliciesRequestOrBuilder
        Returns:
        The bytes for constraint.

      • getFilter

        public String getFilter()
         The expression to filter
 [AnalyzeOrgPoliciesResponse.org_policy_results][google.cloud.asset.v1.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;
        Specified by:
        getFilter in interface AnalyzeOrgPoliciesRequestOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         The expression to filter
 [AnalyzeOrgPoliciesResponse.org_policy_results][google.cloud.asset.v1.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;
        Specified by:
        getFilterBytes in interface AnalyzeOrgPoliciesRequestOrBuilder
        Returns:
        The bytes for filter.

      • hasPageSize

        public boolean hasPageSize()
         The maximum number of items to return per page. If unspecified,
 [AnalyzeOrgPoliciesResponse.org_policy_results][google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.org_policy_results]
 will contain 20 items with a maximum of 200.
        optional int32 page_size = 4;
        Specified by:
        hasPageSize in interface AnalyzeOrgPoliciesRequestOrBuilder
        Returns:
        Whether the pageSize field is set.

      • getPageSize

        public int getPageSize()
         The maximum number of items to return per page. If unspecified,
 [AnalyzeOrgPoliciesResponse.org_policy_results][google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.org_policy_results]
 will contain 20 items with a maximum of 200.
        optional int32 page_size = 4;
        Specified by:
        getPageSize in interface AnalyzeOrgPoliciesRequestOrBuilder
        Returns:
        The pageSize.

      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         The pagination token to retrieve the next page.
        string page_token = 5;
        Specified by:
        getPageTokenBytes in interface AnalyzeOrgPoliciesRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static AnalyzeOrgPoliciesRequest parseFrom​(ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AnalyzeOrgPoliciesRequest parseFrom​(ByteBuffer data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AnalyzeOrgPoliciesRequest parseFrom​(com.google.protobuf.ByteString data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AnalyzeOrgPoliciesRequest parseFrom​(com.google.protobuf.ByteString data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AnalyzeOrgPoliciesRequest parseFrom​(byte[] data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AnalyzeOrgPoliciesRequest parseFrom​(byte[] data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public AnalyzeOrgPoliciesRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public AnalyzeOrgPoliciesRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected AnalyzeOrgPoliciesRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<AnalyzeOrgPoliciesRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public AnalyzeOrgPoliciesRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder