generated/google/apis/securitycenter_v1beta1/service.rb in google-api-client-0.42.2 vs generated/google/apis/securitycenter_v1beta1/service.rb in google-api-client-0.43.0
- old
+ new
@@ -49,12 +49,11 @@
end
# Gets the settings for an organization.
# @param [String] name
# Required. Name of the organization to get organization settings for. Its
- # format is
- # "organizations/[organization_id]/organizationSettings".
+ # format is "organizations/[organization_id]/organizationSettings".
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -80,14 +79,13 @@
execute_or_queue_command(command, &block)
end
# Updates an organization's settings.
# @param [String] name
- # The relative resource name of the settings. See:
- # https://cloud.google.com/apis/design/resource_names#relative_resource_name
- # Example:
- # "organizations/`organization_id`/organizationSettings".
+ # The relative resource name of the settings. See: https://cloud.google.com/apis/
+ # design/resource_names#relative_resource_name Example: "organizations/`
+ # organization_id`/organizationSettings".
# @param [Google::Apis::SecuritycenterV1beta1::OrganizationSettings] organization_settings_object
# @param [String] update_mask
# The FieldMask to use when updating the settings resource.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@@ -117,15 +115,14 @@
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
- # Filters an organization's assets and groups them by their specified
- # properties.
+ # Filters an organization's assets and groups them by their specified properties.
# @param [String] parent
- # Required. Name of the organization to groupBy. Its format is
- # "organizations/[organization_id]".
+ # Required. Name of the organization to groupBy. Its format is "organizations/[
+ # organization_id]".
# @param [Google::Apis::SecuritycenterV1beta1::GroupAssetsRequest] group_assets_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
@@ -154,79 +151,64 @@
execute_or_queue_command(command, &block)
end
# Lists an organization's assets.
# @param [String] parent
- # Required. Name of the organization assets should belong to. Its format is
- # "organizations/[organization_id]".
+ # Required. Name of the organization assets should belong to. Its format is "
+ # organizations/[organization_id]".
# @param [String] compare_duration
# When compare_duration is set, the ListAssetResult's "state" attribute 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 read_time.
- # * "REMOVED": indicates that the asset was present at the start of
- # compare_duration, but not present at read_time.
- # * "ACTIVE": indicates that the asset was present at both the
- # start and the end of the time period defined by
- # compare_duration and read_time.
- # If compare_duration is not specified, then the only possible state is
- # "UNUSED", which indicates that the asset is present at read_time.
+ # 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 read_time. * "REMOVED": indicates that the asset was present at the start
+ # of compare_duration, but not present at read_time. * "ACTIVE": indicates that
+ # the asset was present at both the start and the end of the time period defined
+ # by compare_duration and read_time. If compare_duration is not specified, then
+ # the only possible state is "UNUSED", which indicates that the asset is present
+ # at read_time.
# @param [String] field_mask
# Optional. A field mask to specify the ListAssetsResult fields to be listed in
- # the
- # response.
- # An empty field mask will list all fields.
+ # the response. An empty field mask will list all fields.
# @param [String] filter
- # 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.
+ # 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 ` ` 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.
# @param [String] order_by
- # Expression that defines what fields and order to use for sorting. The
- # string value should follow SQL syntax: comma separated list of fields. For
- # example: "name,resource_properties.a_property". The default sorting order
- # is ascending. To specify descending order for a field, a suffix " desc"
- # should be appended to the field name. For example: "name
- # desc,resource_properties.a_property". Redundant space characters in the
- # syntax are insignificant. "name desc,resource_properties.a_property" and "
- # name desc , resource_properties.a_property " are equivalent.
+ # Expression that defines what fields and order to use for sorting. The string
+ # value should follow SQL syntax: comma separated list of fields. For example: "
+ # name,resource_properties.a_property". The default sorting order is ascending.
+ # To specify descending order for a field, a suffix " desc" should be appended
+ # to the field name. For example: "name desc,resource_properties.a_property".
+ # Redundant space characters in the syntax are insignificant. "name desc,
+ # resource_properties.a_property" and " name desc , resource_properties.
+ # a_property " are equivalent.
# @param [Fixnum] page_size
- # The maximum number of results to return in a single response. Default is
- # 10, minimum is 1, maximum is 1000.
+ # The maximum number of results to return in a single response. Default is 10,
+ # minimum is 1, maximum is 1000.
# @param [String] page_token
- # The value returned by the last `ListAssetsResponse`; indicates
- # that this is a continuation of a prior `ListAssets` call, and
- # that the system should return the next page of data.
+ # The value returned by the last `ListAssetsResponse`; indicates that this is a
+ # continuation of a prior `ListAssets` call, and that the system should return
+ # the next page of data.
# @param [String] read_time
- # 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.
+ # 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.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -257,18 +239,16 @@
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
- # Runs asset discovery. The discovery is tracked with a long-running
- # operation.
- # This API can only be called with limited frequency for an organization. If
- # it is called too frequently the caller will receive a TOO_MANY_REQUESTS
- # error.
+ # Runs asset discovery. The discovery is tracked with a long-running operation.
+ # This API can only be called with limited frequency for an organization. If it
+ # is called too frequently the caller will receive a TOO_MANY_REQUESTS error.
# @param [String] parent
- # Required. Name of the organization to run asset discovery for. Its format is
- # "organizations/[organization_id]".
+ # Required. Name of the organization to run asset discovery for. Its format is "
+ # organizations/[organization_id]".
# @param [Google::Apis::SecuritycenterV1beta1::RunAssetDiscoveryRequest] run_asset_discovery_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
@@ -297,16 +277,14 @@
execute_or_queue_command(command, &block)
end
# Updates security marks.
# @param [String] name
- # The relative resource name of the SecurityMarks. See:
- # https://cloud.google.com/apis/design/resource_names#relative_resource_name
- # Examples:
- # "organizations/`organization_id`/assets/`asset_id`/securityMarks"
- # "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`/
- # securityMarks".
+ # The relative resource name of the SecurityMarks. See: https://cloud.google.com/
+ # apis/design/resource_names#relative_resource_name Examples: "organizations/`
+ # organization_id`/assets/`asset_id`/securityMarks" "organizations/`
+ # organization_id`/sources/`source_id`/findings/`finding_id`/securityMarks".
# @param [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1beta1SecurityMarks] google_cloud_securitycenter_v1beta1_security_marks_object
# @param [String] start_time
# The time at which the updated SecurityMarks take effect.
# @param [String] update_mask
# The FieldMask to use when updating the security marks resource.
@@ -339,19 +317,17 @@
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
- # Starts asynchronous cancellation on a long-running operation. The server
- # makes a best effort to cancel the operation, but success is not
- # guaranteed. If the server doesn't support this method, it returns
- # `google.rpc.Code.UNIMPLEMENTED`. Clients can use
- # Operations.GetOperation or
- # other methods to check whether the cancellation succeeded or whether the
- # operation completed despite cancellation. On successful cancellation,
- # the operation is not deleted; instead, it becomes an operation with
- # an Operation.error value with a google.rpc.Status.code of 1,
+ # Starts asynchronous cancellation on a long-running operation. The server makes
+ # a best effort to cancel the operation, but success is not guaranteed. If the
+ # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+ # Clients can use Operations.GetOperation or other methods to check whether the
+ # cancellation succeeded or whether the operation completed despite cancellation.
+ # On successful cancellation, the operation is not deleted; instead, it becomes
+ # an operation with an Operation.error value with a google.rpc.Status.code of 1,
# corresponding to `Code.CANCELLED`.
# @param [String] name
# The name of the operation resource to be cancelled.
# @param [Google::Apis::SecuritycenterV1beta1::CancelOperationRequest] cancel_operation_request_object
# @param [String] fields
@@ -381,14 +357,14 @@
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
- # Deletes a long-running operation. This method indicates that the client is
- # no longer interested in the operation result. It does not cancel the
- # operation. If the server doesn't support this method, it returns
- # `google.rpc.Code.UNIMPLEMENTED`.
+ # Deletes a long-running operation. This method indicates that the client is no
+ # longer interested in the operation result. It does not cancel the operation.
+ # If the server doesn't support this method, it returns `google.rpc.Code.
+ # UNIMPLEMENTED`.
# @param [String] name
# The name of the operation resource to be deleted.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@@ -414,13 +390,12 @@
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
- # Gets the latest state of a long-running operation. Clients can use this
- # method to poll the operation result at intervals as recommended by the API
- # service.
+ # Gets the latest state of a long-running operation. Clients can use this method
+ # to poll the operation result at intervals as recommended by the API service.
# @param [String] name
# The name of the operation resource.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@@ -446,19 +421,18 @@
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
- # Lists operations that match the specified filter in the request. If the
- # server doesn't support this method, it returns `UNIMPLEMENTED`.
- # NOTE: the `name` binding allows API services to override the binding
- # to use different resource name schemes, such as `users/*/operations`. To
- # override the binding, API services can add a binding such as
- # `"/v1/`name=users/*`/operations"` to their service configuration.
- # For backwards compatibility, the default name includes the operations
- # collection id, however overriding users must ensure the name binding
- # is the parent resource, without the operations collection id.
+ # Lists operations that match the specified filter in the request. If the server
+ # doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
+ # binding allows API services to override the binding to use different resource
+ # name schemes, such as `users/*/operations`. To override the binding, API
+ # services can add a binding such as `"/v1/`name=users/*`/operations"` to their
+ # service configuration. For backwards compatibility, the default name includes
+ # the operations collection id, however overriding users must ensure the name
+ # binding is the parent resource, without the operations collection id.
# @param [String] name
# The name of the operation's parent resource.
# @param [String] filter
# The standard list filter.
# @param [Fixnum] page_size
@@ -495,12 +469,12 @@
execute_or_queue_command(command, &block)
end
# Creates a source.
# @param [String] parent
- # Required. Resource name of the new source's parent. Its format should be
- # "organizations/[organization_id]".
+ # Required. Resource name of the new source's parent. Its format should be "
+ # organizations/[organization_id]".
# @param [Google::Apis::SecuritycenterV1beta1::Source] source_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
@@ -529,12 +503,12 @@
execute_or_queue_command(command, &block)
end
# Gets a source.
# @param [String] name
- # Required. Relative resource name of the source. Its format is
- # "organizations/[organization_id]/source/[source_id]".
+ # Required. Relative resource name of the source. Its format is "organizations/[
+ # organization_id]/source/[source_id]".
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -560,12 +534,12 @@
execute_or_queue_command(command, &block)
end
# Gets the access control policy on the specified Source.
# @param [String] resource
- # REQUIRED: The resource for which the policy is being requested.
- # See the operation documentation for the appropriate value for this field.
+ # REQUIRED: The resource for which the policy is being requested. See the
+ # operation documentation for the appropriate value for this field.
# @param [Google::Apis::SecuritycenterV1beta1::GetIamPolicyRequest] get_iam_policy_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
@@ -597,16 +571,16 @@
# Lists all sources belonging to an organization.
# @param [String] parent
# Required. Resource name of the parent of sources to list. Its format should be
# "organizations/[organization_id]".
# @param [Fixnum] page_size
- # The maximum number of results to return in a single response. Default is
- # 10, minimum is 1, maximum is 1000.
+ # The maximum number of results to return in a single response. Default is 10,
+ # minimum is 1, maximum is 1000.
# @param [String] page_token
- # The value returned by the last `ListSourcesResponse`; indicates
- # that this is a continuation of a prior `ListSources` call, and
- # that the system should return the next page of data.
+ # The value returned by the last `ListSourcesResponse`; indicates that this is a
+ # continuation of a prior `ListSources` call, and that the system should return
+ # the next page of data.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -634,14 +608,13 @@
execute_or_queue_command(command, &block)
end
# Updates a source.
# @param [String] name
- # The relative resource name of this source. See:
- # https://cloud.google.com/apis/design/resource_names#relative_resource_name
- # Example:
- # "organizations/`organization_id`/sources/`source_id`"
+ # The relative resource name of this source. See: https://cloud.google.com/apis/
+ # design/resource_names#relative_resource_name Example: "organizations/`
+ # organization_id`/sources/`source_id`"
# @param [Google::Apis::SecuritycenterV1beta1::Source] source_object
# @param [String] update_mask
# The FieldMask to use when updating the source resource.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@@ -673,12 +646,12 @@
execute_or_queue_command(command, &block)
end
# Sets the access control policy on the specified Source.
# @param [String] resource
- # REQUIRED: The resource for which the policy is being specified.
- # See the operation documentation for the appropriate value for this field.
+ # REQUIRED: The resource for which the policy is being specified. See the
+ # operation documentation for the appropriate value for this field.
# @param [Google::Apis::SecuritycenterV1beta1::SetIamPolicyRequest] set_iam_policy_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
@@ -707,12 +680,12 @@
execute_or_queue_command(command, &block)
end
# Returns the permissions that a caller has on the specified source.
# @param [String] resource
- # REQUIRED: The resource for which the policy detail is being requested.
- # See the operation documentation for the appropriate value for this field.
+ # REQUIRED: The resource for which the policy detail is being requested. See the
+ # operation documentation for the appropriate value for this field.
# @param [Google::Apis::SecuritycenterV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
@@ -739,20 +712,20 @@
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
- # Creates a finding. The corresponding source must exist for finding creation
- # to succeed.
+ # Creates a finding. The corresponding source must exist for finding creation to
+ # succeed.
# @param [String] parent
- # Required. Resource name of the new finding's parent. Its format should be
- # "organizations/[organization_id]/sources/[source_id]".
+ # Required. Resource name of the new finding's parent. Its format should be "
+ # organizations/[organization_id]/sources/[source_id]".
# @param [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1beta1Finding] google_cloud_securitycenter_v1beta1_finding_object
# @param [String] finding_id
- # Required. Unique identifier provided by the client within the parent scope.
- # It must be alphanumeric and less than or equal to 32 characters and
- # greater than 0 characters in length.
+ # Required. Unique identifier provided by the client within the parent scope. It
+ # must be alphanumeric and less than or equal to 32 characters and greater than
+ # 0 characters in length.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -779,19 +752,17 @@
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
- # Filters an organization or source's findings and groups them by their
- # specified properties.
- # To group across all sources provide a `-` as the source id.
- # Example: /v1beta1/organizations/`organization_id`/sources/-/findings
+ # Filters an organization or source's findings and groups them by their
+ # specified properties. To group across all sources provide a `-` as the source
+ # id. Example: /v1beta1/organizations/`organization_id`/sources/-/findings
# @param [String] parent
- # Required. Name of the source to groupBy. Its format is
- # "organizations/[organization_id]/sources/[source_id]". To groupBy across
- # all sources provide a source_id of `-`. For example:
- # organizations/`organization_id`/sources/-
+ # Required. Name of the source to groupBy. Its format is "organizations/[
+ # organization_id]/sources/[source_id]". To groupBy across all sources provide a
+ # source_id of `-`. For example: organizations/`organization_id`/sources/-
# @param [Google::Apis::SecuritycenterV1beta1::GroupFindingsRequest] group_findings_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
@@ -818,62 +789,53 @@
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
- # Lists an organization or source's findings.
- # To list across all sources provide a `-` as the source id.
- # Example: /v1beta1/organizations/`organization_id`/sources/-/findings
+ # Lists an organization or source's findings. To list across all sources provide
+ # a `-` as the source id. Example: /v1beta1/organizations/`organization_id`/
+ # sources/-/findings
# @param [String] parent
- # Required. Name of the source the findings belong to. Its format is
- # "organizations/[organization_id]/sources/[source_id]". To list across all
- # sources provide a source_id of `-`. For example:
- # organizations/`organization_id`/sources/-
+ # Required. Name of the source the findings belong to. Its format is "
+ # organizations/[organization_id]/sources/[source_id]". To list across all
+ # sources provide a source_id of `-`. For example: organizations/`
+ # organization_id`/sources/-
# @param [String] field_mask
# Optional. A field mask to specify the Finding fields to be listed in the
- # response.
- # An empty field mask will list all fields.
+ # response. An empty field mask will list all fields.
# @param [String] filter
- # Expression that defines the filter to apply across findings.
- # The expression is a list of one 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. Examples include:
- # * name
- # * source_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, `source_properties.size = 100` is a valid filter string.
+ # Expression that defines the filter to apply across findings. The expression is
+ # a list of one 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 ` ` and may have a `-` character in front of them
+ # to indicate negation. Examples include: * name * source_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, `source_properties.size = 100` is a valid
+ # filter string.
# @param [String] order_by
- # Expression that defines what fields and order to use for sorting. The
- # string value should follow SQL syntax: comma separated list of fields. For
- # example: "name,resource_properties.a_property". The default sorting order
- # is ascending. To specify descending order for a field, a suffix " desc"
- # should be appended to the field name. For example: "name
- # desc,source_properties.a_property". Redundant space characters in the
- # syntax are insignificant. "name desc,source_properties.a_property" and "
- # name desc , source_properties.a_property " are equivalent.
+ # Expression that defines what fields and order to use for sorting. The string
+ # value should follow SQL syntax: comma separated list of fields. For example: "
+ # name,resource_properties.a_property". The default sorting order is ascending.
+ # To specify descending order for a field, a suffix " desc" should be appended
+ # to the field name. For example: "name desc,source_properties.a_property".
+ # Redundant space characters in the syntax are insignificant. "name desc,
+ # source_properties.a_property" and " name desc , source_properties.a_property "
+ # are equivalent.
# @param [Fixnum] page_size
- # The maximum number of results to return in a single response. Default is
- # 10, minimum is 1, maximum is 1000.
+ # The maximum number of results to return in a single response. Default is 10,
+ # minimum is 1, maximum is 1000.
# @param [String] page_token
- # The value returned by the last `ListFindingsResponse`; indicates
- # that this is a continuation of a prior `ListFindings` call, and
- # that the system should return the next page of data.
+ # The value returned by the last `ListFindingsResponse`; indicates that this is
+ # a continuation of a prior `ListFindings` call, and that the system should
+ # return the next page of data.
# @param [String] read_time
- # Time used as a reference point when filtering findings. The filter is
- # limited to findings 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.
+ # Time used as a reference point when filtering findings. The filter is limited
+ # to findings 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.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -906,18 +868,17 @@
end
# Creates or updates a finding. The corresponding source must exist for a
# finding creation to succeed.
# @param [String] name
- # The relative resource name of this finding. See:
- # https://cloud.google.com/apis/design/resource_names#relative_resource_name
- # Example:
- # "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`"
+ # The relative resource name of this finding. See: https://cloud.google.com/apis/
+ # design/resource_names#relative_resource_name Example: "organizations/`
+ # organization_id`/sources/`source_id`/findings/`finding_id`"
# @param [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1beta1Finding] google_cloud_securitycenter_v1beta1_finding_object
# @param [String] update_mask
- # The FieldMask to use when updating the finding resource. This field should
- # not be specified when creating a finding.
+ # The FieldMask to use when updating the finding resource. This field should not
+ # be specified when creating a finding.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -946,14 +907,13 @@
execute_or_queue_command(command, &block)
end
# Updates the state of a finding.
# @param [String] name
- # Required. The relative resource name of the finding. See:
- # https://cloud.google.com/apis/design/resource_names#relative_resource_name
- # Example:
- # "organizations/`organization_id`/sources/`source_id`/finding/`finding_id`".
+ # Required. The relative resource name of the finding. See: https://cloud.google.
+ # com/apis/design/resource_names#relative_resource_name Example: "organizations/`
+ # organization_id`/sources/`source_id`/finding/`finding_id`".
# @param [Google::Apis::SecuritycenterV1beta1::SetFindingStateRequest] set_finding_state_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
@@ -982,15 +942,13 @@
execute_or_queue_command(command, &block)
end
# Updates security marks.
# @param [String] name
- # The relative resource name of the SecurityMarks. See:
- # https://cloud.google.com/apis/design/resource_names#relative_resource_name
- # Examples:
- # "organizations/`organization_id`/assets/`asset_id`/securityMarks"
- # "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`/
- # securityMarks".
+ # The relative resource name of the SecurityMarks. See: https://cloud.google.com/
+ # apis/design/resource_names#relative_resource_name Examples: "organizations/`
+ # organization_id`/assets/`asset_id`/securityMarks" "organizations/`
+ # organization_id`/sources/`source_id`/findings/`finding_id`/securityMarks".
# @param [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1beta1SecurityMarks] google_cloud_securitycenter_v1beta1_security_marks_object
# @param [String] start_time
# The time at which the updated SecurityMarks take effect.
# @param [String] update_mask
# The FieldMask to use when updating the security marks resource.