Package com.google.cloud.securitycenter.v1beta1

Class GroupAssetsRequest

  • All Implemented Interfaces:
    GroupAssetsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class GroupAssetsRequest
extends com.google.protobuf.GeneratedMessageV3
implements GroupAssetsRequestOrBuilder
     Request message for grouping by assets.
    Protobuf type google.cloud.securitycenter.v1beta1.GroupAssetsRequest
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  GroupAssetsRequest.Builder
      Request message for grouping by assets.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      com.google.protobuf.Duration getCompareDuration()
      When compare_duration is set, the Asset's "state" property is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time.
      com.google.protobuf.DurationOrBuilder getCompareDurationOrBuilder()
      When compare_duration is set, the Asset's "state" property is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time.
      static GroupAssetsRequest getDefaultInstance()  
      GroupAssetsRequest getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      String getFilter()
      Expression that defines the filter to apply across assets.
      com.google.protobuf.ByteString getFilterBytes()
      Expression that defines the filter to apply across assets.
      String getGroupBy()
      Required.
      com.google.protobuf.ByteString getGroupByBytes()
      Required.
      int getPageSize()
      The maximum number of results to return in a single response.
      String getPageToken()
      The value returned by the last `GroupAssetsResponse`; indicates that this is a continuation of a prior `GroupAssets` call, and that the system should return the next page of data.
      com.google.protobuf.ByteString getPageTokenBytes()
      The value returned by the last `GroupAssetsResponse`; indicates that this is a continuation of a prior `GroupAssets` call, and that the system should return the next page of data.
      String getParent()
      Required.
      com.google.protobuf.ByteString getParentBytes()
      Required.
      com.google.protobuf.Parser<GroupAssetsRequest> getParserForType()  
      com.google.protobuf.Timestamp getReadTime()
      Time used as a reference point when filtering assets.
      com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder()
      Time used as a reference point when filtering assets.
      int getSerializedSize()  
      boolean hasCompareDuration()
      When compare_duration is set, the Asset's "state" property is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time.
      int hashCode()  
      boolean hasReadTime()
      Time used as a reference point when filtering assets.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static GroupAssetsRequest.Builder newBuilder()  
      static GroupAssetsRequest.Builder newBuilder​(GroupAssetsRequest prototype)  
      GroupAssetsRequest.Builder newBuilderForType()  
      protected GroupAssetsRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static GroupAssetsRequest parseDelimitedFrom​(InputStream input)  
      static GroupAssetsRequest parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static GroupAssetsRequest parseFrom​(byte[] data)  
      static GroupAssetsRequest parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static GroupAssetsRequest parseFrom​(com.google.protobuf.ByteString data)  
      static GroupAssetsRequest parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static GroupAssetsRequest parseFrom​(com.google.protobuf.CodedInputStream input)  
      static GroupAssetsRequest parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static GroupAssetsRequest parseFrom​(InputStream input)  
      static GroupAssetsRequest parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static GroupAssetsRequest parseFrom​(ByteBuffer data)  
      static GroupAssetsRequest parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<GroupAssetsRequest> parser()  
      GroupAssetsRequest.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • 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

      • getParent

        public String getParent()
         Required. Name of the organization to groupBy. Its format is
 "organizations/[organization_id]".
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParent in interface GroupAssetsRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         Required. Name of the organization to groupBy. Its format is
 "organizations/[organization_id]".
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParentBytes in interface GroupAssetsRequestOrBuilder
        Returns:
        The bytes for parent.

      • getFilter

        public String getFilter()
         Expression that defines the filter to apply across assets.
 The expression is a list of zero or more restrictions combined via logical
 operators `AND` and `OR`.
 Parentheses are not supported, and `OR` has higher precedence than `AND`.

 Restrictions have the form `<field> <operator> <value>` and may have a `-`
 character in front of them to indicate negation. The fields map to those
 defined in the Asset resource. Examples include:

 * name
 * security_center_properties.resource_name
 * resource_properties.a_property
 * security_marks.marks.marka

 The supported operators are:

 * `=` for all value types.
 * `>`, `<`, `>=`, `<=` for integer values.
 * `:`, meaning substring matching, for strings.

 The supported value types are:

 * string literals in quotes.
 * integer literals without quotes.
 * boolean literals `true` and `false` without quotes.

 For example, `resource_properties.size = 100` is a valid filter string.
        string filter = 2;
        Specified by:
        getFilter in interface GroupAssetsRequestOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         Expression that defines the filter to apply across assets.
 The expression is a list of zero or more restrictions combined via logical
 operators `AND` and `OR`.
 Parentheses are not supported, and `OR` has higher precedence than `AND`.

 Restrictions have the form `<field> <operator> <value>` and may have a `-`
 character in front of them to indicate negation. The fields map to those
 defined in the Asset resource. Examples include:

 * name
 * security_center_properties.resource_name
 * resource_properties.a_property
 * security_marks.marks.marka

 The supported operators are:

 * `=` for all value types.
 * `>`, `<`, `>=`, `<=` for integer values.
 * `:`, meaning substring matching, for strings.

 The supported value types are:

 * string literals in quotes.
 * integer literals without quotes.
 * boolean literals `true` and `false` without quotes.

 For example, `resource_properties.size = 100` is a valid filter string.
        string filter = 2;
        Specified by:
        getFilterBytes in interface GroupAssetsRequestOrBuilder
        Returns:
        The bytes for filter.

      • getGroupBy

        public String getGroupBy()
         Required. Expression that defines what assets fields to use for grouping. The string
 value should follow SQL syntax: comma separated list of fields. For
 example:
 "security_center_properties.resource_project,security_center_properties.project".

 The following fields are supported when compare_duration is not set:

 * security_center_properties.resource_project
 * security_center_properties.resource_type
 * security_center_properties.resource_parent

 The following fields are supported when compare_duration is set:

 * security_center_properties.resource_type
        string group_by = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getGroupBy in interface GroupAssetsRequestOrBuilder
        Returns:
        The groupBy.

      • getGroupByBytes

        public com.google.protobuf.ByteString getGroupByBytes()
         Required. Expression that defines what assets fields to use for grouping. The string
 value should follow SQL syntax: comma separated list of fields. For
 example:
 "security_center_properties.resource_project,security_center_properties.project".

 The following fields are supported when compare_duration is not set:

 * security_center_properties.resource_project
 * security_center_properties.resource_type
 * security_center_properties.resource_parent

 The following fields are supported when compare_duration is set:

 * security_center_properties.resource_type
        string group_by = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getGroupByBytes in interface GroupAssetsRequestOrBuilder
        Returns:
        The bytes for groupBy.

      • hasCompareDuration

        public boolean hasCompareDuration()
         When compare_duration is set, the Asset's "state" property is updated to
 indicate whether the asset was added, removed, or remained present during
 the compare_duration period of time that precedes the read_time. This is
 the time between (read_time - compare_duration) and read_time.

 The state value is derived based on the presence of the asset at the two
 points in time. Intermediate state changes between the two times don't
 affect the result. For example, the results aren't affected if the asset is
 removed and re-created again.

 Possible "state" values when compare_duration is specified:

 * "ADDED": indicates that the asset was not present before
              compare_duration, but present at reference_time.
 * "REMOVED": indicates that the asset was present at the start of
              compare_duration, but not present at reference_time.
 * "ACTIVE": indicates that the asset was present at both the
              start and the end of the time period defined by
              compare_duration and reference_time.

 This field is ignored if `state` is not a field in `group_by`.
        .google.protobuf.Duration compare_duration = 4;
        Specified by:
        hasCompareDuration in interface GroupAssetsRequestOrBuilder
        Returns:
        Whether the compareDuration field is set.

      • getCompareDuration

        public com.google.protobuf.Duration getCompareDuration()
         When compare_duration is set, the Asset's "state" property is updated to
 indicate whether the asset was added, removed, or remained present during
 the compare_duration period of time that precedes the read_time. This is
 the time between (read_time - compare_duration) and read_time.

 The state value is derived based on the presence of the asset at the two
 points in time. Intermediate state changes between the two times don't
 affect the result. For example, the results aren't affected if the asset is
 removed and re-created again.

 Possible "state" values when compare_duration is specified:

 * "ADDED": indicates that the asset was not present before
              compare_duration, but present at reference_time.
 * "REMOVED": indicates that the asset was present at the start of
              compare_duration, but not present at reference_time.
 * "ACTIVE": indicates that the asset was present at both the
              start and the end of the time period defined by
              compare_duration and reference_time.

 This field is ignored if `state` is not a field in `group_by`.
        .google.protobuf.Duration compare_duration = 4;
        Specified by:
        getCompareDuration in interface GroupAssetsRequestOrBuilder
        Returns:
        The compareDuration.

      • getCompareDurationOrBuilder

        public com.google.protobuf.DurationOrBuilder getCompareDurationOrBuilder()
         When compare_duration is set, the Asset's "state" property is updated to
 indicate whether the asset was added, removed, or remained present during
 the compare_duration period of time that precedes the read_time. This is
 the time between (read_time - compare_duration) and read_time.

 The state value is derived based on the presence of the asset at the two
 points in time. Intermediate state changes between the two times don't
 affect the result. For example, the results aren't affected if the asset is
 removed and re-created again.

 Possible "state" values when compare_duration is specified:

 * "ADDED": indicates that the asset was not present before
              compare_duration, but present at reference_time.
 * "REMOVED": indicates that the asset was present at the start of
              compare_duration, but not present at reference_time.
 * "ACTIVE": indicates that the asset was present at both the
              start and the end of the time period defined by
              compare_duration and reference_time.

 This field is ignored if `state` is not a field in `group_by`.
        .google.protobuf.Duration compare_duration = 4;
        Specified by:
        getCompareDurationOrBuilder in interface GroupAssetsRequestOrBuilder

      • hasReadTime

        public boolean hasReadTime()
         Time used as a reference point when filtering assets. The filter is limited
 to assets existing at the supplied time and their values are those at that
 specific time. Absence of this field will default to the API's version of
 NOW.
        .google.protobuf.Timestamp read_time = 5;
        Specified by:
        hasReadTime in interface GroupAssetsRequestOrBuilder
        Returns:
        Whether the readTime field is set.

      • getReadTime

        public com.google.protobuf.Timestamp getReadTime()
         Time used as a reference point when filtering assets. The filter is limited
 to assets existing at the supplied time and their values are those at that
 specific time. Absence of this field will default to the API's version of
 NOW.
        .google.protobuf.Timestamp read_time = 5;
        Specified by:
        getReadTime in interface GroupAssetsRequestOrBuilder
        Returns:
        The readTime.

      • getReadTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder()
         Time used as a reference point when filtering assets. The filter is limited
 to assets existing at the supplied time and their values are those at that
 specific time. Absence of this field will default to the API's version of
 NOW.
        .google.protobuf.Timestamp read_time = 5;
        Specified by:
        getReadTimeOrBuilder in interface GroupAssetsRequestOrBuilder

      • getPageToken

        public String getPageToken()
         The value returned by the last `GroupAssetsResponse`; indicates
 that this is a continuation of a prior `GroupAssets` call, and that the
 system should return the next page of data.
        string page_token = 7;
        Specified by:
        getPageToken in interface GroupAssetsRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         The value returned by the last `GroupAssetsResponse`; indicates
 that this is a continuation of a prior `GroupAssets` call, and that the
 system should return the next page of data.
        string page_token = 7;
        Specified by:
        getPageTokenBytes in interface GroupAssetsRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • getPageSize

        public int getPageSize()
         The maximum number of results to return in a single response. Default is
 10, minimum is 1, maximum is 1000.
        int32 page_size = 8;
        Specified by:
        getPageSize in interface GroupAssetsRequestOrBuilder
        Returns:
        The pageSize.

      • 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 GroupAssetsRequest parseFrom​(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static GroupAssetsRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
        Throws:
        IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<GroupAssetsRequest> 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 GroupAssetsRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder