datalossprevention.v1beta1.jobTrigger

"JobTrigger is the Schema for the JobTriggers API. A job trigger configuration."

Index

fn new(name)
obj metadata
obj spec

Fields

fn new

new(name)

new returns an instance of JobTrigger

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

fn metadata.withSelfLink

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"JobTriggerSpec defines the desired state of JobTrigger"

fn spec.withDeletionPolicy

withDeletionPolicy(deletionPolicy)

"DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either \"Delete\" or \"Orphan\" the external resource. This field is planned to be deprecated in favor of the ManagementPolicies field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223"

fn spec.withManagementPolicies

withManagementPolicies(managementPolicies)

"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md"

fn spec.withManagementPoliciesMixin

withManagementPoliciesMixin(managementPolicies)

"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md"

Note: This function appends passed data to existing values

obj spec.forProvider

fn spec.forProvider.withDescription

withDescription(description)

"A description of the job trigger."

fn spec.forProvider.withDisplayName

withDisplayName(displayName)

"User set display name of the job trigger."

fn spec.forProvider.withInspectJob

withInspectJob(inspectJob)

"Controls what and how to inspect for findings. Structure is documented below."

fn spec.forProvider.withInspectJobMixin

withInspectJobMixin(inspectJob)

"Controls what and how to inspect for findings. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.withParent

withParent(parent)

"The parent of the trigger, either in the format projects/{{project}} or projects/{{project}}/locations/{{location}}"

fn spec.forProvider.withTriggers

withTriggers(triggers)

"What event needs to occur for a new job to be started. Structure is documented below."

fn spec.forProvider.withTriggersMixin

withTriggersMixin(triggers)

"What event needs to occur for a new job to be started. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.inspectJob

"Controls what and how to inspect for findings. Structure is documented below."

fn spec.forProvider.inspectJob.withActions

withActions(actions)

"A task to execute on the completion of a job. Structure is documented below."

fn spec.forProvider.inspectJob.withActionsMixin

withActionsMixin(actions)

"A task to execute on the completion of a job. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.withInspectConfig

withInspectConfig(inspectConfig)

"The core content of the template. Structure is documented below."

fn spec.forProvider.inspectJob.withInspectConfigMixin

withInspectConfigMixin(inspectConfig)

"The core content of the template. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.withInspectTemplateName

withInspectTemplateName(inspectTemplateName)

"The name of the template to run when this job is triggered."

fn spec.forProvider.inspectJob.withStorageConfig

withStorageConfig(storageConfig)

"Information on where to inspect Structure is documented below."

fn spec.forProvider.inspectJob.withStorageConfigMixin

withStorageConfigMixin(storageConfig)

"Information on where to inspect Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.inspectJob.actions

"A task to execute on the completion of a job. Structure is documented below."

fn spec.forProvider.inspectJob.actions.withDeidentify

withDeidentify(deidentify)

"Create a de-identified copy of the requested table or files. Structure is documented below."

fn spec.forProvider.inspectJob.actions.withDeidentifyMixin

withDeidentifyMixin(deidentify)

"Create a de-identified copy of the requested table or files. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.actions.withJobNotificationEmails

withJobNotificationEmails(jobNotificationEmails)

"Sends an email when the job completes. The email goes to IAM project owners and technical Essential Contacts."

fn spec.forProvider.inspectJob.actions.withJobNotificationEmailsMixin

withJobNotificationEmailsMixin(jobNotificationEmails)

"Sends an email when the job completes. The email goes to IAM project owners and technical Essential Contacts."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.actions.withPubSub

withPubSub(pubSub)

"Publish a message into a given Pub/Sub topic when the job completes. Structure is documented below."

fn spec.forProvider.inspectJob.actions.withPubSubMixin

withPubSubMixin(pubSub)

"Publish a message into a given Pub/Sub topic when the job completes. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.actions.withPublishFindingsToCloudDataCatalog

withPublishFindingsToCloudDataCatalog(publishFindingsToCloudDataCatalog)

"Publish findings of a DlpJob to Data Catalog."

fn spec.forProvider.inspectJob.actions.withPublishFindingsToCloudDataCatalogMixin

withPublishFindingsToCloudDataCatalogMixin(publishFindingsToCloudDataCatalog)

"Publish findings of a DlpJob to Data Catalog."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.actions.withPublishSummaryToCscc

withPublishSummaryToCscc(publishSummaryToCscc)

"Publish the result summary of a DlpJob to the Cloud Security Command Center."

fn spec.forProvider.inspectJob.actions.withPublishSummaryToCsccMixin

withPublishSummaryToCsccMixin(publishSummaryToCscc)

"Publish the result summary of a DlpJob to the Cloud Security Command Center."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.actions.withPublishToStackdriver

withPublishToStackdriver(publishToStackdriver)

"Enable Stackdriver metric dlp.googleapis.com/findingCount."

fn spec.forProvider.inspectJob.actions.withPublishToStackdriverMixin

withPublishToStackdriverMixin(publishToStackdriver)

"Enable Stackdriver metric dlp.googleapis.com/findingCount."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.actions.withSaveFindings

withSaveFindings(saveFindings)

"If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk Structure is documented below."

fn spec.forProvider.inspectJob.actions.withSaveFindingsMixin

withSaveFindingsMixin(saveFindings)

"If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.inspectJob.actions.deidentify

"Create a de-identified copy of the requested table or files. Structure is documented below."

fn spec.forProvider.inspectJob.actions.deidentify.withCloudStorageOutput

withCloudStorageOutput(cloudStorageOutput)

"User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for cloud storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket"

fn spec.forProvider.inspectJob.actions.deidentify.withFileTypesToTransform

withFileTypesToTransform(fileTypesToTransform)

"List of user-specified file type groups to transform. If specified, only the files with these filetypes will be transformed. If empty, all supported files will be transformed. Supported types may be automatically added over time. If a file type is set in this field that isn't supported by the Deidentify action then the job will fail and will not be successfully created/started. Each value may be one of: IMAGE, TEXT_FILE, CSV, TSV."

fn spec.forProvider.inspectJob.actions.deidentify.withFileTypesToTransformMixin

withFileTypesToTransformMixin(fileTypesToTransform)

"List of user-specified file type groups to transform. If specified, only the files with these filetypes will be transformed. If empty, all supported files will be transformed. Supported types may be automatically added over time. If a file type is set in this field that isn't supported by the Deidentify action then the job will fail and will not be successfully created/started. Each value may be one of: IMAGE, TEXT_FILE, CSV, TSV."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.actions.deidentify.withTransformationConfig

withTransformationConfig(transformationConfig)

"User specified deidentify templates and configs for structured, unstructured, and image files. Structure is documented below."

fn spec.forProvider.inspectJob.actions.deidentify.withTransformationConfigMixin

withTransformationConfigMixin(transformationConfig)

"User specified deidentify templates and configs for structured, unstructured, and image files. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.actions.deidentify.withTransformationDetailsStorageConfig

withTransformationDetailsStorageConfig(transformationDetailsStorageConfig)

"Config for storing transformation details. Structure is documented below."

fn spec.forProvider.inspectJob.actions.deidentify.withTransformationDetailsStorageConfigMixin

withTransformationDetailsStorageConfigMixin(transformationDetailsStorageConfig)

"Config for storing transformation details. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.inspectJob.actions.deidentify.transformationConfig

"User specified deidentify templates and configs for structured, unstructured, and image files. Structure is documented below."

fn spec.forProvider.inspectJob.actions.deidentify.transformationConfig.withDeidentifyTemplate

withDeidentifyTemplate(deidentifyTemplate)

"If this template is specified, it will serve as the default de-identify template."

fn spec.forProvider.inspectJob.actions.deidentify.transformationConfig.withImageRedactTemplate

withImageRedactTemplate(imageRedactTemplate)

"If this template is specified, it will serve as the de-identify template for images."

fn spec.forProvider.inspectJob.actions.deidentify.transformationConfig.withStructuredDeidentifyTemplate

withStructuredDeidentifyTemplate(structuredDeidentifyTemplate)

"If this template is specified, it will serve as the de-identify template for structured content such as delimited files and tables."

obj spec.forProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig

"Config for storing transformation details. Structure is documented below."

fn spec.forProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.withTable

withTable(table)

"The BigQuery table in which to store the output. Structure is documented below."

fn spec.forProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.withTableMixin

withTableMixin(table)

"The BigQuery table in which to store the output. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.table

"The BigQuery table in which to store the output. Structure is documented below."

fn spec.forProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.table.withDatasetId

withDatasetId(datasetId)

"The ID of the dataset containing this table."

fn spec.forProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.table.withProjectId

withProjectId(projectId)

"The ID of the project containing this table."

fn spec.forProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.table.withTableId

withTableId(tableId)

"The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters."

obj spec.forProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.table.datasetIdRef

"Reference to a Dataset in bigquery to populate datasetId."

fn spec.forProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.table.datasetIdRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.table.datasetIdRef.policy

"Policies for referencing."

fn spec.forProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.table.datasetIdRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.table.datasetIdRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.table.datasetIdSelector

"Selector for a Dataset in bigquery to populate datasetId."

fn spec.forProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.table.datasetIdSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.table.datasetIdSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.table.datasetIdSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.table.datasetIdSelector.policy

"Policies for selection."

fn spec.forProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.table.datasetIdSelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.table.datasetIdSelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.table.tableIdRef

"Reference to a Table in bigquery to populate tableId."

fn spec.forProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.table.tableIdRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.table.tableIdRef.policy

"Policies for referencing."

fn spec.forProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.table.tableIdRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.table.tableIdRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.table.tableIdSelector

"Selector for a Table in bigquery to populate tableId."

fn spec.forProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.table.tableIdSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.table.tableIdSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.table.tableIdSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.table.tableIdSelector.policy

"Policies for selection."

fn spec.forProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.table.tableIdSelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.table.tableIdSelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.inspectJob.actions.pubSub

"Publish a message into a given Pub/Sub topic when the job completes. Structure is documented below."

fn spec.forProvider.inspectJob.actions.pubSub.withTopic

withTopic(topic)

"Cloud Pub/Sub topic to send notifications to."

obj spec.forProvider.inspectJob.actions.saveFindings

"If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk Structure is documented below."

fn spec.forProvider.inspectJob.actions.saveFindings.withOutputConfig

withOutputConfig(outputConfig)

"Information on where to store output Structure is documented below."

fn spec.forProvider.inspectJob.actions.saveFindings.withOutputConfigMixin

withOutputConfigMixin(outputConfig)

"Information on where to store output Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.inspectJob.actions.saveFindings.outputConfig

"Information on where to store output Structure is documented below."

fn spec.forProvider.inspectJob.actions.saveFindings.outputConfig.withOutputSchema

withOutputSchema(outputSchema)

"Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the Finding object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. Possible values are: BASIC_COLUMNS, GCS_COLUMNS, DATASTORE_COLUMNS, BIG_QUERY_COLUMNS, ALL_COLUMNS."

fn spec.forProvider.inspectJob.actions.saveFindings.outputConfig.withTable

withTable(table)

"The BigQuery table in which to store the output. Structure is documented below."

fn spec.forProvider.inspectJob.actions.saveFindings.outputConfig.withTableMixin

withTableMixin(table)

"The BigQuery table in which to store the output. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.inspectJob.actions.saveFindings.outputConfig.table

"The BigQuery table in which to store the output. Structure is documented below."

fn spec.forProvider.inspectJob.actions.saveFindings.outputConfig.table.withDatasetId

withDatasetId(datasetId)

"The ID of the dataset containing this table."

fn spec.forProvider.inspectJob.actions.saveFindings.outputConfig.table.withProjectId

withProjectId(projectId)

"The ID of the project containing this table."

fn spec.forProvider.inspectJob.actions.saveFindings.outputConfig.table.withTableId

withTableId(tableId)

"The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters."

obj spec.forProvider.inspectJob.inspectConfig

"The core content of the template. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.withCustomInfoTypes

withCustomInfoTypes(customInfoTypes)

"Custom info types to be used. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.withCustomInfoTypesMixin

withCustomInfoTypesMixin(customInfoTypes)

"Custom info types to be used. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.inspectConfig.withExcludeInfoTypes

withExcludeInfoTypes(excludeInfoTypes)

"When true, excludes type information of the findings."

fn spec.forProvider.inspectJob.inspectConfig.withIncludeQuote

withIncludeQuote(includeQuote)

"When true, a contextual quote from the data that triggered a finding is included in the response."

fn spec.forProvider.inspectJob.inspectConfig.withInfoTypes

withInfoTypes(infoTypes)

"List of infoTypes this rule set is applied to. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.withInfoTypesMixin

withInfoTypesMixin(infoTypes)

"List of infoTypes this rule set is applied to. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.inspectConfig.withLimits

withLimits(limits)

"Configuration to control the number of findings returned. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.withLimitsMixin

withLimitsMixin(limits)

"Configuration to control the number of findings returned. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.inspectConfig.withMinLikelihood

withMinLikelihood(minLikelihood)

"Only returns findings equal or above this threshold. See https://cloud.google.com/dlp/docs/likelihood for more info Default value is POSSIBLE. Possible values are: VERY_UNLIKELY, UNLIKELY, POSSIBLE, LIKELY, VERY_LIKELY."

fn spec.forProvider.inspectJob.inspectConfig.withRuleSet

withRuleSet(ruleSet)

"Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.withRuleSetMixin

withRuleSetMixin(ruleSet)

"Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.inspectJob.inspectConfig.customInfoTypes

"Custom info types to be used. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.customInfoTypes.withDictionary

withDictionary(dictionary)

"Dictionary which defines the rule. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.customInfoTypes.withDictionaryMixin

withDictionaryMixin(dictionary)

"Dictionary which defines the rule. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.inspectConfig.customInfoTypes.withExclusionType

withExclusionType(exclusionType)

"If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Possible values are: EXCLUSION_TYPE_EXCLUDE."

fn spec.forProvider.inspectJob.inspectConfig.customInfoTypes.withInfoType

withInfoType(infoType)

"Type of information the findings limit applies to. Only one limit per infoType should be provided. If InfoTypeLimit does not have an infoType, the DLP API applies the limit against all infoTypes that are found but not specified in another InfoTypeLimit. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.customInfoTypes.withInfoTypeMixin

withInfoTypeMixin(infoType)

"Type of information the findings limit applies to. Only one limit per infoType should be provided. If InfoTypeLimit does not have an infoType, the DLP API applies the limit against all infoTypes that are found but not specified in another InfoTypeLimit. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.inspectConfig.customInfoTypes.withLikelihood

withLikelihood(likelihood)

"Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Default value is VERY_LIKELY. Possible values are: VERY_UNLIKELY, UNLIKELY, POSSIBLE, LIKELY, VERY_LIKELY."

fn spec.forProvider.inspectJob.inspectConfig.customInfoTypes.withRegex

withRegex(regex)

"Regular expression which defines the rule. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.customInfoTypes.withRegexMixin

withRegexMixin(regex)

"Regular expression which defines the rule. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.inspectConfig.customInfoTypes.withStoredType

withStoredType(storedType)

"A reference to a StoredInfoType to use with scanning. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.customInfoTypes.withStoredTypeMixin

withStoredTypeMixin(storedType)

"A reference to a StoredInfoType to use with scanning. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.inspectConfig.customInfoTypes.withSurrogateType

withSurrogateType(surrogateType)

"Message for detecting output from deidentification transformations that support reversing."

fn spec.forProvider.inspectJob.inspectConfig.customInfoTypes.withSurrogateTypeMixin

withSurrogateTypeMixin(surrogateType)

"Message for detecting output from deidentification transformations that support reversing."

Note: This function appends passed data to existing values

obj spec.forProvider.inspectJob.inspectConfig.customInfoTypes.dictionary

"Dictionary which defines the rule. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.customInfoTypes.dictionary.withCloudStoragePath

withCloudStoragePath(cloudStoragePath)

"Newline-delimited file of words in Cloud Storage. Only a single file is accepted. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.customInfoTypes.dictionary.withCloudStoragePathMixin

withCloudStoragePathMixin(cloudStoragePath)

"Newline-delimited file of words in Cloud Storage. Only a single file is accepted. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.inspectConfig.customInfoTypes.dictionary.withWordList

withWordList(wordList)

"List of words or phrases to search for. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.customInfoTypes.dictionary.withWordListMixin

withWordListMixin(wordList)

"List of words or phrases to search for. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.inspectJob.inspectConfig.customInfoTypes.dictionary.cloudStoragePath

"Newline-delimited file of words in Cloud Storage. Only a single file is accepted. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.customInfoTypes.dictionary.cloudStoragePath.withPath

withPath(path)

"A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt"

obj spec.forProvider.inspectJob.inspectConfig.customInfoTypes.dictionary.wordList

"List of words or phrases to search for. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.customInfoTypes.dictionary.wordList.withWords

withWords(words)

"Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits."

fn spec.forProvider.inspectJob.inspectConfig.customInfoTypes.dictionary.wordList.withWordsMixin

withWordsMixin(words)

"Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits."

Note: This function appends passed data to existing values

obj spec.forProvider.inspectJob.inspectConfig.customInfoTypes.infoType

"Type of information the findings limit applies to. Only one limit per infoType should be provided. If InfoTypeLimit does not have an infoType, the DLP API applies the limit against all infoTypes that are found but not specified in another InfoTypeLimit. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.customInfoTypes.infoType.withName

withName(name)

"Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: Required to filter out rows based on the given start and end times. If not specified and the table was modified between the given start and end times, the entire table will be scanned. The valid data types of the timestamp field are: INTEGER, DATE, TIMESTAMP, or DATETIME BigQuery column. For Datastore. Valid data types of the timestamp field are: TIMESTAMP. Datastore entity will be scanned if the timestamp property does not exist or its value is empty or invalid."

fn spec.forProvider.inspectJob.inspectConfig.customInfoTypes.infoType.withVersion

withVersion(version)

"Version of the information type to use. By default, the version is set to stable"

obj spec.forProvider.inspectJob.inspectConfig.customInfoTypes.regex

"Regular expression which defines the rule. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.customInfoTypes.regex.withGroupIndexes

withGroupIndexes(groupIndexes)

"The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included."

fn spec.forProvider.inspectJob.inspectConfig.customInfoTypes.regex.withGroupIndexesMixin

withGroupIndexesMixin(groupIndexes)

"The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.inspectConfig.customInfoTypes.regex.withPattern

withPattern(pattern)

"Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub."

obj spec.forProvider.inspectJob.inspectConfig.customInfoTypes.storedType

"A reference to a StoredInfoType to use with scanning. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.customInfoTypes.storedType.withName

withName(name)

"Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: Required to filter out rows based on the given start and end times. If not specified and the table was modified between the given start and end times, the entire table will be scanned. The valid data types of the timestamp field are: INTEGER, DATE, TIMESTAMP, or DATETIME BigQuery column. For Datastore. Valid data types of the timestamp field are: TIMESTAMP. Datastore entity will be scanned if the timestamp property does not exist or its value is empty or invalid."

obj spec.forProvider.inspectJob.inspectConfig.infoTypes

"List of infoTypes this rule set is applied to. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.infoTypes.withName

withName(name)

"Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: Required to filter out rows based on the given start and end times. If not specified and the table was modified between the given start and end times, the entire table will be scanned. The valid data types of the timestamp field are: INTEGER, DATE, TIMESTAMP, or DATETIME BigQuery column. For Datastore. Valid data types of the timestamp field are: TIMESTAMP. Datastore entity will be scanned if the timestamp property does not exist or its value is empty or invalid."

fn spec.forProvider.inspectJob.inspectConfig.infoTypes.withVersion

withVersion(version)

"Version of the information type to use. By default, the version is set to stable"

obj spec.forProvider.inspectJob.inspectConfig.limits

"Configuration to control the number of findings returned. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.limits.withMaxFindingsPerInfoType

withMaxFindingsPerInfoType(maxFindingsPerInfoType)

"Configuration of findings limit given for specified infoTypes. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.limits.withMaxFindingsPerInfoTypeMixin

withMaxFindingsPerInfoTypeMixin(maxFindingsPerInfoType)

"Configuration of findings limit given for specified infoTypes. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.inspectConfig.limits.withMaxFindingsPerItem

withMaxFindingsPerItem(maxFindingsPerItem)

"Max number of findings that will be returned for each item scanned. The maximum returned is 2000."

fn spec.forProvider.inspectJob.inspectConfig.limits.withMaxFindingsPerRequest

withMaxFindingsPerRequest(maxFindingsPerRequest)

"Max number of findings that will be returned per request/job. The maximum returned is 2000."

obj spec.forProvider.inspectJob.inspectConfig.limits.maxFindingsPerInfoType

"Configuration of findings limit given for specified infoTypes. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.limits.maxFindingsPerInfoType.withInfoType

withInfoType(infoType)

"Type of information the findings limit applies to. Only one limit per infoType should be provided. If InfoTypeLimit does not have an infoType, the DLP API applies the limit against all infoTypes that are found but not specified in another InfoTypeLimit. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.limits.maxFindingsPerInfoType.withInfoTypeMixin

withInfoTypeMixin(infoType)

"Type of information the findings limit applies to. Only one limit per infoType should be provided. If InfoTypeLimit does not have an infoType, the DLP API applies the limit against all infoTypes that are found but not specified in another InfoTypeLimit. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.inspectConfig.limits.maxFindingsPerInfoType.withMaxFindings

withMaxFindings(maxFindings)

"Max findings limit for the given infoType."

obj spec.forProvider.inspectJob.inspectConfig.limits.maxFindingsPerInfoType.infoType

"Type of information the findings limit applies to. Only one limit per infoType should be provided. If InfoTypeLimit does not have an infoType, the DLP API applies the limit against all infoTypes that are found but not specified in another InfoTypeLimit. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.limits.maxFindingsPerInfoType.infoType.withName

withName(name)

"Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: Required to filter out rows based on the given start and end times. If not specified and the table was modified between the given start and end times, the entire table will be scanned. The valid data types of the timestamp field are: INTEGER, DATE, TIMESTAMP, or DATETIME BigQuery column. For Datastore. Valid data types of the timestamp field are: TIMESTAMP. Datastore entity will be scanned if the timestamp property does not exist or its value is empty or invalid."

fn spec.forProvider.inspectJob.inspectConfig.limits.maxFindingsPerInfoType.infoType.withVersion

withVersion(version)

"Version of the information type to use. By default, the version is set to stable"

obj spec.forProvider.inspectJob.inspectConfig.ruleSet

"Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.withInfoTypes

withInfoTypes(infoTypes)

"List of infoTypes this rule set is applied to. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.withInfoTypesMixin

withInfoTypesMixin(infoTypes)

"List of infoTypes this rule set is applied to. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.withRules

withRules(rules)

"Set of rules to be applied to infoTypes. The rules are applied in order. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.withRulesMixin

withRulesMixin(rules)

"Set of rules to be applied to infoTypes. The rules are applied in order. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.inspectJob.inspectConfig.ruleSet.infoTypes

"List of infoTypes this rule set is applied to. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.infoTypes.withName

withName(name)

"Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: Required to filter out rows based on the given start and end times. If not specified and the table was modified between the given start and end times, the entire table will be scanned. The valid data types of the timestamp field are: INTEGER, DATE, TIMESTAMP, or DATETIME BigQuery column. For Datastore. Valid data types of the timestamp field are: TIMESTAMP. Datastore entity will be scanned if the timestamp property does not exist or its value is empty or invalid."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.infoTypes.withVersion

withVersion(version)

"Version of the information type to use. By default, the version is set to stable"

obj spec.forProvider.inspectJob.inspectConfig.ruleSet.rules

"Set of rules to be applied to infoTypes. The rules are applied in order. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.withExclusionRule

withExclusionRule(exclusionRule)

"The rule that specifies conditions when findings of infoTypes specified in InspectionRuleSet are removed from results. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.withExclusionRuleMixin

withExclusionRuleMixin(exclusionRule)

"The rule that specifies conditions when findings of infoTypes specified in InspectionRuleSet are removed from results. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.withHotwordRule

withHotwordRule(hotwordRule)

"Hotword-based detection rule. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.withHotwordRuleMixin

withHotwordRuleMixin(hotwordRule)

"Hotword-based detection rule. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule

"The rule that specifies conditions when findings of infoTypes specified in InspectionRuleSet are removed from results. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.withDictionary

withDictionary(dictionary)

"Dictionary which defines the rule. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.withDictionaryMixin

withDictionaryMixin(dictionary)

"Dictionary which defines the rule. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.withExcludeByHotword

withExcludeByHotword(excludeByHotword)

"Drop if the hotword rule is contained in the proximate context. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.withExcludeByHotwordMixin

withExcludeByHotwordMixin(excludeByHotword)

"Drop if the hotword rule is contained in the proximate context. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.withExcludeInfoTypes

withExcludeInfoTypes(excludeInfoTypes)

"When true, excludes type information of the findings."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.withExcludeInfoTypesMixin

withExcludeInfoTypesMixin(excludeInfoTypes)

"When true, excludes type information of the findings."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.withMatchingType

withMatchingType(matchingType)

"How the rule is applied. See the documentation for more information: https://cloud.google.com/dlp/docs/reference/rest/v2/InspectConfig#MatchingType Possible values are: MATCHING_TYPE_FULL_MATCH, MATCHING_TYPE_PARTIAL_MATCH, MATCHING_TYPE_INVERSE_MATCH."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.withRegex

withRegex(regex)

"Regular expression which defines the rule. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.withRegexMixin

withRegexMixin(regex)

"Regular expression which defines the rule. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.dictionary

"Dictionary which defines the rule. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.dictionary.withCloudStoragePath

withCloudStoragePath(cloudStoragePath)

"Newline-delimited file of words in Cloud Storage. Only a single file is accepted. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.dictionary.withCloudStoragePathMixin

withCloudStoragePathMixin(cloudStoragePath)

"Newline-delimited file of words in Cloud Storage. Only a single file is accepted. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.dictionary.withWordList

withWordList(wordList)

"List of words or phrases to search for. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.dictionary.withWordListMixin

withWordListMixin(wordList)

"List of words or phrases to search for. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.dictionary.cloudStoragePath

"Newline-delimited file of words in Cloud Storage. Only a single file is accepted. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.dictionary.cloudStoragePath.withPath

withPath(path)

"A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt"

obj spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.dictionary.wordList

"List of words or phrases to search for. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.dictionary.wordList.withWords

withWords(words)

"Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.dictionary.wordList.withWordsMixin

withWordsMixin(words)

"Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits."

Note: This function appends passed data to existing values

obj spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeByHotword

"Drop if the hotword rule is contained in the proximate context. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeByHotword.withHotwordRegex

withHotwordRegex(hotwordRegex)

"Regular expression pattern defining what qualifies as a hotword. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeByHotword.withHotwordRegexMixin

withHotwordRegexMixin(hotwordRegex)

"Regular expression pattern defining what qualifies as a hotword. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeByHotword.withProximity

withProximity(proximity)

"Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex (\d{3}) \d{3}-\d{4} could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex (xxx), where xxx is the area code in question. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeByHotword.withProximityMixin

withProximityMixin(proximity)

"Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex (\d{3}) \d{3}-\d{4} could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex (xxx), where xxx is the area code in question. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeByHotword.hotwordRegex

"Regular expression pattern defining what qualifies as a hotword. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeByHotword.hotwordRegex.withGroupIndexes

withGroupIndexes(groupIndexes)

"The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeByHotword.hotwordRegex.withGroupIndexesMixin

withGroupIndexesMixin(groupIndexes)

"The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeByHotword.hotwordRegex.withPattern

withPattern(pattern)

"Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub."

obj spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeByHotword.proximity

"Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex (\d{3}) \d{3}-\d{4} could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex (xxx), where xxx is the area code in question. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeByHotword.proximity.withWindowAfter

withWindowAfter(windowAfter)

"Number of characters after the finding to consider. Either this or window_before must be specified"

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeByHotword.proximity.withWindowBefore

withWindowBefore(windowBefore)

"Number of characters before the finding to consider. Either this or window_after must be specified"

obj spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeInfoTypes

"When true, excludes type information of the findings."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeInfoTypes.withInfoTypes

withInfoTypes(infoTypes)

"List of infoTypes this rule set is applied to. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeInfoTypes.withInfoTypesMixin

withInfoTypesMixin(infoTypes)

"List of infoTypes this rule set is applied to. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeInfoTypes.infoTypes

"List of infoTypes this rule set is applied to. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeInfoTypes.infoTypes.withName

withName(name)

"Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: Required to filter out rows based on the given start and end times. If not specified and the table was modified between the given start and end times, the entire table will be scanned. The valid data types of the timestamp field are: INTEGER, DATE, TIMESTAMP, or DATETIME BigQuery column. For Datastore. Valid data types of the timestamp field are: TIMESTAMP. Datastore entity will be scanned if the timestamp property does not exist or its value is empty or invalid."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeInfoTypes.infoTypes.withVersion

withVersion(version)

"Version of the information type to use. By default, the version is set to stable"

obj spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.regex

"Regular expression which defines the rule. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.regex.withGroupIndexes

withGroupIndexes(groupIndexes)

"The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.regex.withGroupIndexesMixin

withGroupIndexesMixin(groupIndexes)

"The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.regex.withPattern

withPattern(pattern)

"Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub."

obj spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule

"Hotword-based detection rule. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.withHotwordRegex

withHotwordRegex(hotwordRegex)

"Regular expression pattern defining what qualifies as a hotword. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.withHotwordRegexMixin

withHotwordRegexMixin(hotwordRegex)

"Regular expression pattern defining what qualifies as a hotword. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.withLikelihoodAdjustment

withLikelihoodAdjustment(likelihoodAdjustment)

"Likelihood adjustment to apply to all matching findings. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.withLikelihoodAdjustmentMixin

withLikelihoodAdjustmentMixin(likelihoodAdjustment)

"Likelihood adjustment to apply to all matching findings. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.withProximity

withProximity(proximity)

"Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex (\d{3}) \d{3}-\d{4} could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex (xxx), where xxx is the area code in question. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.withProximityMixin

withProximityMixin(proximity)

"Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex (\d{3}) \d{3}-\d{4} could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex (xxx), where xxx is the area code in question. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.hotwordRegex

"Regular expression pattern defining what qualifies as a hotword. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.hotwordRegex.withGroupIndexes

withGroupIndexes(groupIndexes)

"The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.hotwordRegex.withGroupIndexesMixin

withGroupIndexesMixin(groupIndexes)

"The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.hotwordRegex.withPattern

withPattern(pattern)

"Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub."

obj spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.likelihoodAdjustment

"Likelihood adjustment to apply to all matching findings. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.likelihoodAdjustment.withFixedLikelihood

withFixedLikelihood(fixedLikelihood)

"Set the likelihood of a finding to a fixed value. Either this or relative_likelihood can be set. Possible values are: VERY_UNLIKELY, UNLIKELY, POSSIBLE, LIKELY, VERY_LIKELY."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.likelihoodAdjustment.withRelativeLikelihood

withRelativeLikelihood(relativeLikelihood)

"Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be POSSIBLE without the detection rule and relativeLikelihood is 1, then it is upgraded to LIKELY, while a value of -1 would downgrade it to UNLIKELY. Likelihood may never drop below VERY_UNLIKELY or exceed VERY_LIKELY, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is VERY_LIKELY will result in a final likelihood of LIKELY. Either this or fixed_likelihood can be set."

obj spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.proximity

"Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex (\d{3}) \d{3}-\d{4} could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex (xxx), where xxx is the area code in question. Structure is documented below."

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.proximity.withWindowAfter

withWindowAfter(windowAfter)

"Number of characters after the finding to consider. Either this or window_before must be specified"

fn spec.forProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.proximity.withWindowBefore

withWindowBefore(windowBefore)

"Number of characters before the finding to consider. Either this or window_after must be specified"

obj spec.forProvider.inspectJob.storageConfig

"Information on where to inspect Structure is documented below."

fn spec.forProvider.inspectJob.storageConfig.withBigQueryOptions

withBigQueryOptions(bigQueryOptions)

"Options defining BigQuery table and row identifiers. Structure is documented below."

fn spec.forProvider.inspectJob.storageConfig.withBigQueryOptionsMixin

withBigQueryOptionsMixin(bigQueryOptions)

"Options defining BigQuery table and row identifiers. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.storageConfig.withCloudStorageOptions

withCloudStorageOptions(cloudStorageOptions)

"Options defining a file or a set of files within a Google Cloud Storage bucket. Structure is documented below."

fn spec.forProvider.inspectJob.storageConfig.withCloudStorageOptionsMixin

withCloudStorageOptionsMixin(cloudStorageOptions)

"Options defining a file or a set of files within a Google Cloud Storage bucket. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.storageConfig.withDatastoreOptions

withDatastoreOptions(datastoreOptions)

"Options defining a data set within Google Cloud Datastore. Structure is documented below."

fn spec.forProvider.inspectJob.storageConfig.withDatastoreOptionsMixin

withDatastoreOptionsMixin(datastoreOptions)

"Options defining a data set within Google Cloud Datastore. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.storageConfig.withHybridOptions

withHybridOptions(hybridOptions)

"Configuration to control jobs where the content being inspected is outside of Google Cloud Platform. Structure is documented below."

fn spec.forProvider.inspectJob.storageConfig.withHybridOptionsMixin

withHybridOptionsMixin(hybridOptions)

"Configuration to control jobs where the content being inspected is outside of Google Cloud Platform. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.storageConfig.withTimespanConfig

withTimespanConfig(timespanConfig)

"Information on where to inspect Structure is documented below."

fn spec.forProvider.inspectJob.storageConfig.withTimespanConfigMixin

withTimespanConfigMixin(timespanConfig)

"Information on where to inspect Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.inspectJob.storageConfig.bigQueryOptions

"Options defining BigQuery table and row identifiers. Structure is documented below."

fn spec.forProvider.inspectJob.storageConfig.bigQueryOptions.withIdentifyingFields

withIdentifyingFields(identifyingFields)

"The columns that are the primary keys for table objects included in ContentItem. A copy of this cell's value will stored alongside alongside each finding so that the finding can be traced to the specific row it came from. No more than 3 may be provided. Structure is documented below."

fn spec.forProvider.inspectJob.storageConfig.bigQueryOptions.withIdentifyingFieldsMixin

withIdentifyingFieldsMixin(identifyingFields)

"The columns that are the primary keys for table objects included in ContentItem. A copy of this cell's value will stored alongside alongside each finding so that the finding can be traced to the specific row it came from. No more than 3 may be provided. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.storageConfig.bigQueryOptions.withRowsLimit

withRowsLimit(rowsLimit)

"Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rowsLimit and rowsLimitPercent can be specified. Cannot be used in conjunction with TimespanConfig."

fn spec.forProvider.inspectJob.storageConfig.bigQueryOptions.withRowsLimitPercent

withRowsLimitPercent(rowsLimitPercent)

"Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rowsLimit and rowsLimitPercent can be specified. Cannot be used in conjunction with TimespanConfig."

fn spec.forProvider.inspectJob.storageConfig.bigQueryOptions.withSampleMethod

withSampleMethod(sampleMethod)

"How to sample bytes if not all bytes are scanned. Meaningful only when used in conjunction with bytesLimitPerFile. If not specified, scanning would start from the top. Possible values are: TOP, RANDOM_START."

fn spec.forProvider.inspectJob.storageConfig.bigQueryOptions.withTableReference

withTableReference(tableReference)

"Set of files to scan. Structure is documented below."

fn spec.forProvider.inspectJob.storageConfig.bigQueryOptions.withTableReferenceMixin

withTableReferenceMixin(tableReference)

"Set of files to scan. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.inspectJob.storageConfig.bigQueryOptions.identifyingFields

"The columns that are the primary keys for table objects included in ContentItem. A copy of this cell's value will stored alongside alongside each finding so that the finding can be traced to the specific row it came from. No more than 3 may be provided. Structure is documented below."

fn spec.forProvider.inspectJob.storageConfig.bigQueryOptions.identifyingFields.withName

withName(name)

"Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: Required to filter out rows based on the given start and end times. If not specified and the table was modified between the given start and end times, the entire table will be scanned. The valid data types of the timestamp field are: INTEGER, DATE, TIMESTAMP, or DATETIME BigQuery column. For Datastore. Valid data types of the timestamp field are: TIMESTAMP. Datastore entity will be scanned if the timestamp property does not exist or its value is empty or invalid."

obj spec.forProvider.inspectJob.storageConfig.bigQueryOptions.tableReference

"Set of files to scan. Structure is documented below."

fn spec.forProvider.inspectJob.storageConfig.bigQueryOptions.tableReference.withDatasetId

withDatasetId(datasetId)

"The ID of the dataset containing this table."

fn spec.forProvider.inspectJob.storageConfig.bigQueryOptions.tableReference.withProjectId

withProjectId(projectId)

"The ID of the project containing this table."

fn spec.forProvider.inspectJob.storageConfig.bigQueryOptions.tableReference.withTableId

withTableId(tableId)

"The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters."

obj spec.forProvider.inspectJob.storageConfig.cloudStorageOptions

"Options defining a file or a set of files within a Google Cloud Storage bucket. Structure is documented below."

fn spec.forProvider.inspectJob.storageConfig.cloudStorageOptions.withBytesLimitPerFile

withBytesLimitPerFile(bytesLimitPerFile)

"Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted."

fn spec.forProvider.inspectJob.storageConfig.cloudStorageOptions.withBytesLimitPerFilePercent

withBytesLimitPerFilePercent(bytesLimitPerFilePercent)

"Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit."

fn spec.forProvider.inspectJob.storageConfig.cloudStorageOptions.withFileSet

withFileSet(fileSet)

"Set of files to scan. Structure is documented below."

fn spec.forProvider.inspectJob.storageConfig.cloudStorageOptions.withFileSetMixin

withFileSetMixin(fileSet)

"Set of files to scan. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.storageConfig.cloudStorageOptions.withFileTypes

withFileTypes(fileTypes)

"List of file type groups to include in the scan. If empty, all files are scanned and available data format processors are applied. In addition, the binary content of the selected files is always scanned as well. Images are scanned only as binary if the specified region does not support image inspection and no fileTypes were specified. Each value may be one of: BINARY_FILE, TEXT_FILE, IMAGE, WORD, PDF, AVRO, CSV, TSV."

fn spec.forProvider.inspectJob.storageConfig.cloudStorageOptions.withFileTypesMixin

withFileTypesMixin(fileTypes)

"List of file type groups to include in the scan. If empty, all files are scanned and available data format processors are applied. In addition, the binary content of the selected files is always scanned as well. Images are scanned only as binary if the specified region does not support image inspection and no fileTypes were specified. Each value may be one of: BINARY_FILE, TEXT_FILE, IMAGE, WORD, PDF, AVRO, CSV, TSV."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.storageConfig.cloudStorageOptions.withFilesLimitPercent

withFilesLimitPercent(filesLimitPercent)

"Limits the number of files to scan to this percentage of the input FileSet. Number of files scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit."

fn spec.forProvider.inspectJob.storageConfig.cloudStorageOptions.withSampleMethod

withSampleMethod(sampleMethod)

"How to sample bytes if not all bytes are scanned. Meaningful only when used in conjunction with bytesLimitPerFile. If not specified, scanning would start from the top. Possible values are: TOP, RANDOM_START."

obj spec.forProvider.inspectJob.storageConfig.cloudStorageOptions.fileSet

"Set of files to scan. Structure is documented below."

fn spec.forProvider.inspectJob.storageConfig.cloudStorageOptions.fileSet.withRegexFileSet

withRegexFileSet(regexFileSet)

"The regex-filtered set of files to scan. Structure is documented below."

fn spec.forProvider.inspectJob.storageConfig.cloudStorageOptions.fileSet.withRegexFileSetMixin

withRegexFileSetMixin(regexFileSet)

"The regex-filtered set of files to scan. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.storageConfig.cloudStorageOptions.fileSet.withUrl

withUrl(url)

"The Cloud Storage url of the file(s) to scan, in the format gs:///. Trailing wildcard in the path is allowed. If the url ends in a trailing slash, the bucket or directory represented by the url will be scanned non-recursively (content in sub-directories will not be scanned). This means that gs://mybucket/ is equivalent to gs://mybucket/, and gs://mybucket/directory/ is equivalent to gs://mybucket/directory/."

obj spec.forProvider.inspectJob.storageConfig.cloudStorageOptions.fileSet.regexFileSet

"The regex-filtered set of files to scan. Structure is documented below."

fn spec.forProvider.inspectJob.storageConfig.cloudStorageOptions.fileSet.regexFileSet.withBucketName

withBucketName(bucketName)

"The name of a Cloud Storage bucket."

fn spec.forProvider.inspectJob.storageConfig.cloudStorageOptions.fileSet.regexFileSet.withExcludeRegex

withExcludeRegex(excludeRegex)

"A list of regular expressions matching file paths to exclude. All files in the bucket that match at least one of these regular expressions will be excluded from the scan."

fn spec.forProvider.inspectJob.storageConfig.cloudStorageOptions.fileSet.regexFileSet.withExcludeRegexMixin

withExcludeRegexMixin(excludeRegex)

"A list of regular expressions matching file paths to exclude. All files in the bucket that match at least one of these regular expressions will be excluded from the scan."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.storageConfig.cloudStorageOptions.fileSet.regexFileSet.withIncludeRegex

withIncludeRegex(includeRegex)

"A list of regular expressions matching file paths to include. All files in the bucket that match at least one of these regular expressions will be included in the set of files, except for those that also match an item in excludeRegex. Leaving this field empty will match all files by default (this is equivalent to including .* in the list)"

fn spec.forProvider.inspectJob.storageConfig.cloudStorageOptions.fileSet.regexFileSet.withIncludeRegexMixin

withIncludeRegexMixin(includeRegex)

"A list of regular expressions matching file paths to include. All files in the bucket that match at least one of these regular expressions will be included in the set of files, except for those that also match an item in excludeRegex. Leaving this field empty will match all files by default (this is equivalent to including .* in the list)"

Note: This function appends passed data to existing values

obj spec.forProvider.inspectJob.storageConfig.datastoreOptions

"Options defining a data set within Google Cloud Datastore. Structure is documented below."

fn spec.forProvider.inspectJob.storageConfig.datastoreOptions.withKind

withKind(kind)

"A representation of a Datastore kind. Structure is documented below."

fn spec.forProvider.inspectJob.storageConfig.datastoreOptions.withKindMixin

withKindMixin(kind)

"A representation of a Datastore kind. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.storageConfig.datastoreOptions.withPartitionId

withPartitionId(partitionId)

"Datastore partition ID. A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. Structure is documented below."

fn spec.forProvider.inspectJob.storageConfig.datastoreOptions.withPartitionIdMixin

withPartitionIdMixin(partitionId)

"Datastore partition ID. A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.inspectJob.storageConfig.datastoreOptions.kind

"A representation of a Datastore kind. Structure is documented below."

fn spec.forProvider.inspectJob.storageConfig.datastoreOptions.kind.withName

withName(name)

"Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: Required to filter out rows based on the given start and end times. If not specified and the table was modified between the given start and end times, the entire table will be scanned. The valid data types of the timestamp field are: INTEGER, DATE, TIMESTAMP, or DATETIME BigQuery column. For Datastore. Valid data types of the timestamp field are: TIMESTAMP. Datastore entity will be scanned if the timestamp property does not exist or its value is empty or invalid."

obj spec.forProvider.inspectJob.storageConfig.datastoreOptions.partitionId

"Datastore partition ID. A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. Structure is documented below."

fn spec.forProvider.inspectJob.storageConfig.datastoreOptions.partitionId.withNamespaceId

withNamespaceId(namespaceId)

"If not empty, the ID of the namespace to which the entities belong."

fn spec.forProvider.inspectJob.storageConfig.datastoreOptions.partitionId.withProjectId

withProjectId(projectId)

"The ID of the project containing this table."

obj spec.forProvider.inspectJob.storageConfig.hybridOptions

"Configuration to control jobs where the content being inspected is outside of Google Cloud Platform. Structure is documented below."

fn spec.forProvider.inspectJob.storageConfig.hybridOptions.withDescription

withDescription(description)

"A description of the job trigger."

fn spec.forProvider.inspectJob.storageConfig.hybridOptions.withLabels

withLabels(labels)

"To organize findings, these labels will be added to each finding. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?. No more than 10 labels can be associated with a given finding. Examples:"

fn spec.forProvider.inspectJob.storageConfig.hybridOptions.withLabelsMixin

withLabelsMixin(labels)

"To organize findings, these labels will be added to each finding. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?. No more than 10 labels can be associated with a given finding. Examples:"

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.storageConfig.hybridOptions.withRequiredFindingLabelKeys

withRequiredFindingLabelKeys(requiredFindingLabelKeys)

"These are labels that each inspection request must include within their 'finding_labels' map. Request may contain others, but any missing one of these will be rejected. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. No more than 10 keys can be required."

fn spec.forProvider.inspectJob.storageConfig.hybridOptions.withRequiredFindingLabelKeysMixin

withRequiredFindingLabelKeysMixin(requiredFindingLabelKeys)

"These are labels that each inspection request must include within their 'finding_labels' map. Request may contain others, but any missing one of these will be rejected. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. No more than 10 keys can be required."

Note: This function appends passed data to existing values

fn spec.forProvider.inspectJob.storageConfig.hybridOptions.withTableOptions

withTableOptions(tableOptions)

"If the container is a table, additional information to make findings meaningful such as the columns that are primary keys. Structure is documented below."

fn spec.forProvider.inspectJob.storageConfig.hybridOptions.withTableOptionsMixin

withTableOptionsMixin(tableOptions)

"If the container is a table, additional information to make findings meaningful such as the columns that are primary keys. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.inspectJob.storageConfig.hybridOptions.tableOptions

"If the container is a table, additional information to make findings meaningful such as the columns that are primary keys. Structure is documented below."

fn spec.forProvider.inspectJob.storageConfig.hybridOptions.tableOptions.withIdentifyingFields

withIdentifyingFields(identifyingFields)

"The columns that are the primary keys for table objects included in ContentItem. A copy of this cell's value will stored alongside alongside each finding so that the finding can be traced to the specific row it came from. No more than 3 may be provided. Structure is documented below."

fn spec.forProvider.inspectJob.storageConfig.hybridOptions.tableOptions.withIdentifyingFieldsMixin

withIdentifyingFieldsMixin(identifyingFields)

"The columns that are the primary keys for table objects included in ContentItem. A copy of this cell's value will stored alongside alongside each finding so that the finding can be traced to the specific row it came from. No more than 3 may be provided. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.inspectJob.storageConfig.hybridOptions.tableOptions.identifyingFields

"The columns that are the primary keys for table objects included in ContentItem. A copy of this cell's value will stored alongside alongside each finding so that the finding can be traced to the specific row it came from. No more than 3 may be provided. Structure is documented below."

fn spec.forProvider.inspectJob.storageConfig.hybridOptions.tableOptions.identifyingFields.withName

withName(name)

"Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: Required to filter out rows based on the given start and end times. If not specified and the table was modified between the given start and end times, the entire table will be scanned. The valid data types of the timestamp field are: INTEGER, DATE, TIMESTAMP, or DATETIME BigQuery column. For Datastore. Valid data types of the timestamp field are: TIMESTAMP. Datastore entity will be scanned if the timestamp property does not exist or its value is empty or invalid."

obj spec.forProvider.inspectJob.storageConfig.timespanConfig

"Information on where to inspect Structure is documented below."

fn spec.forProvider.inspectJob.storageConfig.timespanConfig.withEnableAutoPopulationOfTimespanConfig

withEnableAutoPopulationOfTimespanConfig(enableAutoPopulationOfTimespanConfig)

"When the job is started by a JobTrigger we will automatically figure out a valid startTime to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger."

fn spec.forProvider.inspectJob.storageConfig.timespanConfig.withEndTime

withEndTime(endTime)

"Exclude files or rows newer than this value. If set to zero, no upper time limit is applied."

fn spec.forProvider.inspectJob.storageConfig.timespanConfig.withStartTime

withStartTime(startTime)

"Exclude files or rows older than this value."

fn spec.forProvider.inspectJob.storageConfig.timespanConfig.withTimestampField

withTimestampField(timestampField)

"Information on where to inspect Structure is documented below."

fn spec.forProvider.inspectJob.storageConfig.timespanConfig.withTimestampFieldMixin

withTimestampFieldMixin(timestampField)

"Information on where to inspect Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.inspectJob.storageConfig.timespanConfig.timestampField

"Information on where to inspect Structure is documented below."

fn spec.forProvider.inspectJob.storageConfig.timespanConfig.timestampField.withName

withName(name)

"Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: Required to filter out rows based on the given start and end times. If not specified and the table was modified between the given start and end times, the entire table will be scanned. The valid data types of the timestamp field are: INTEGER, DATE, TIMESTAMP, or DATETIME BigQuery column. For Datastore. Valid data types of the timestamp field are: TIMESTAMP. Datastore entity will be scanned if the timestamp property does not exist or its value is empty or invalid."

obj spec.forProvider.triggers

"What event needs to occur for a new job to be started. Structure is documented below."

fn spec.forProvider.triggers.withManual

withManual(manual)

"For use with hybrid jobs. Jobs must be manually created and finished."

fn spec.forProvider.triggers.withManualMixin

withManualMixin(manual)

"For use with hybrid jobs. Jobs must be manually created and finished."

Note: This function appends passed data to existing values

fn spec.forProvider.triggers.withSchedule

withSchedule(schedule)

"Schedule for triggered jobs Structure is documented below."

fn spec.forProvider.triggers.withScheduleMixin

withScheduleMixin(schedule)

"Schedule for triggered jobs Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.triggers.schedule

"Schedule for triggered jobs Structure is documented below."

fn spec.forProvider.triggers.schedule.withRecurrencePeriodDuration

withRecurrencePeriodDuration(recurrencePeriodDuration)

"With this option a job is started a regular periodic basis. For example: every day (86400 seconds). A scheduled start time will be skipped if the previous execution has not ended when its scheduled time occurs. This value must be set to a time duration greater than or equal to 1 day and can be no longer than 60 days. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: \"3.5s\"."

obj spec.initProvider

"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler."

fn spec.initProvider.withDescription

withDescription(description)

"A description of the job trigger."

fn spec.initProvider.withDisplayName

withDisplayName(displayName)

"User set display name of the job trigger."

fn spec.initProvider.withInspectJob

withInspectJob(inspectJob)

"Controls what and how to inspect for findings. Structure is documented below."

fn spec.initProvider.withInspectJobMixin

withInspectJobMixin(inspectJob)

"Controls what and how to inspect for findings. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.withParent

withParent(parent)

"The parent of the trigger, either in the format projects/{{project}} or projects/{{project}}/locations/{{location}}"

fn spec.initProvider.withTriggers

withTriggers(triggers)

"What event needs to occur for a new job to be started. Structure is documented below."

fn spec.initProvider.withTriggersMixin

withTriggersMixin(triggers)

"What event needs to occur for a new job to be started. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.inspectJob

"Controls what and how to inspect for findings. Structure is documented below."

fn spec.initProvider.inspectJob.withActions

withActions(actions)

"A task to execute on the completion of a job. Structure is documented below."

fn spec.initProvider.inspectJob.withActionsMixin

withActionsMixin(actions)

"A task to execute on the completion of a job. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.withInspectConfig

withInspectConfig(inspectConfig)

"The core content of the template. Structure is documented below."

fn spec.initProvider.inspectJob.withInspectConfigMixin

withInspectConfigMixin(inspectConfig)

"The core content of the template. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.withInspectTemplateName

withInspectTemplateName(inspectTemplateName)

"The name of the template to run when this job is triggered."

fn spec.initProvider.inspectJob.withStorageConfig

withStorageConfig(storageConfig)

"Information on where to inspect Structure is documented below."

fn spec.initProvider.inspectJob.withStorageConfigMixin

withStorageConfigMixin(storageConfig)

"Information on where to inspect Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.inspectJob.actions

"A task to execute on the completion of a job. Structure is documented below."

fn spec.initProvider.inspectJob.actions.withDeidentify

withDeidentify(deidentify)

"Create a de-identified copy of the requested table or files. Structure is documented below."

fn spec.initProvider.inspectJob.actions.withDeidentifyMixin

withDeidentifyMixin(deidentify)

"Create a de-identified copy of the requested table or files. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.actions.withJobNotificationEmails

withJobNotificationEmails(jobNotificationEmails)

"Sends an email when the job completes. The email goes to IAM project owners and technical Essential Contacts."

fn spec.initProvider.inspectJob.actions.withJobNotificationEmailsMixin

withJobNotificationEmailsMixin(jobNotificationEmails)

"Sends an email when the job completes. The email goes to IAM project owners and technical Essential Contacts."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.actions.withPubSub

withPubSub(pubSub)

"Publish a message into a given Pub/Sub topic when the job completes. Structure is documented below."

fn spec.initProvider.inspectJob.actions.withPubSubMixin

withPubSubMixin(pubSub)

"Publish a message into a given Pub/Sub topic when the job completes. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.actions.withPublishFindingsToCloudDataCatalog

withPublishFindingsToCloudDataCatalog(publishFindingsToCloudDataCatalog)

"Publish findings of a DlpJob to Data Catalog."

fn spec.initProvider.inspectJob.actions.withPublishFindingsToCloudDataCatalogMixin

withPublishFindingsToCloudDataCatalogMixin(publishFindingsToCloudDataCatalog)

"Publish findings of a DlpJob to Data Catalog."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.actions.withPublishSummaryToCscc

withPublishSummaryToCscc(publishSummaryToCscc)

"Publish the result summary of a DlpJob to the Cloud Security Command Center."

fn spec.initProvider.inspectJob.actions.withPublishSummaryToCsccMixin

withPublishSummaryToCsccMixin(publishSummaryToCscc)

"Publish the result summary of a DlpJob to the Cloud Security Command Center."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.actions.withPublishToStackdriver

withPublishToStackdriver(publishToStackdriver)

"Enable Stackdriver metric dlp.googleapis.com/findingCount."

fn spec.initProvider.inspectJob.actions.withPublishToStackdriverMixin

withPublishToStackdriverMixin(publishToStackdriver)

"Enable Stackdriver metric dlp.googleapis.com/findingCount."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.actions.withSaveFindings

withSaveFindings(saveFindings)

"If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk Structure is documented below."

fn spec.initProvider.inspectJob.actions.withSaveFindingsMixin

withSaveFindingsMixin(saveFindings)

"If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.inspectJob.actions.deidentify

"Create a de-identified copy of the requested table or files. Structure is documented below."

fn spec.initProvider.inspectJob.actions.deidentify.withCloudStorageOutput

withCloudStorageOutput(cloudStorageOutput)

"User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for cloud storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket"

fn spec.initProvider.inspectJob.actions.deidentify.withFileTypesToTransform

withFileTypesToTransform(fileTypesToTransform)

"List of user-specified file type groups to transform. If specified, only the files with these filetypes will be transformed. If empty, all supported files will be transformed. Supported types may be automatically added over time. If a file type is set in this field that isn't supported by the Deidentify action then the job will fail and will not be successfully created/started. Each value may be one of: IMAGE, TEXT_FILE, CSV, TSV."

fn spec.initProvider.inspectJob.actions.deidentify.withFileTypesToTransformMixin

withFileTypesToTransformMixin(fileTypesToTransform)

"List of user-specified file type groups to transform. If specified, only the files with these filetypes will be transformed. If empty, all supported files will be transformed. Supported types may be automatically added over time. If a file type is set in this field that isn't supported by the Deidentify action then the job will fail and will not be successfully created/started. Each value may be one of: IMAGE, TEXT_FILE, CSV, TSV."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.actions.deidentify.withTransformationConfig

withTransformationConfig(transformationConfig)

"User specified deidentify templates and configs for structured, unstructured, and image files. Structure is documented below."

fn spec.initProvider.inspectJob.actions.deidentify.withTransformationConfigMixin

withTransformationConfigMixin(transformationConfig)

"User specified deidentify templates and configs for structured, unstructured, and image files. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.actions.deidentify.withTransformationDetailsStorageConfig

withTransformationDetailsStorageConfig(transformationDetailsStorageConfig)

"Config for storing transformation details. Structure is documented below."

fn spec.initProvider.inspectJob.actions.deidentify.withTransformationDetailsStorageConfigMixin

withTransformationDetailsStorageConfigMixin(transformationDetailsStorageConfig)

"Config for storing transformation details. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.inspectJob.actions.deidentify.transformationConfig

"User specified deidentify templates and configs for structured, unstructured, and image files. Structure is documented below."

fn spec.initProvider.inspectJob.actions.deidentify.transformationConfig.withDeidentifyTemplate

withDeidentifyTemplate(deidentifyTemplate)

"If this template is specified, it will serve as the default de-identify template."

fn spec.initProvider.inspectJob.actions.deidentify.transformationConfig.withImageRedactTemplate

withImageRedactTemplate(imageRedactTemplate)

"If this template is specified, it will serve as the de-identify template for images."

fn spec.initProvider.inspectJob.actions.deidentify.transformationConfig.withStructuredDeidentifyTemplate

withStructuredDeidentifyTemplate(structuredDeidentifyTemplate)

"If this template is specified, it will serve as the de-identify template for structured content such as delimited files and tables."

obj spec.initProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig

"Config for storing transformation details. Structure is documented below."

fn spec.initProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.withTable

withTable(table)

"The BigQuery table in which to store the output. Structure is documented below."

fn spec.initProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.withTableMixin

withTableMixin(table)

"The BigQuery table in which to store the output. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.table

"The BigQuery table in which to store the output. Structure is documented below."

fn spec.initProvider.inspectJob.actions.deidentify.transformationDetailsStorageConfig.table.withProjectId

withProjectId(projectId)

"The ID of the project containing this table."

obj spec.initProvider.inspectJob.actions.pubSub

"Publish a message into a given Pub/Sub topic when the job completes. Structure is documented below."

fn spec.initProvider.inspectJob.actions.pubSub.withTopic

withTopic(topic)

"Cloud Pub/Sub topic to send notifications to."

obj spec.initProvider.inspectJob.actions.saveFindings

"If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk Structure is documented below."

fn spec.initProvider.inspectJob.actions.saveFindings.withOutputConfig

withOutputConfig(outputConfig)

"Information on where to store output Structure is documented below."

fn spec.initProvider.inspectJob.actions.saveFindings.withOutputConfigMixin

withOutputConfigMixin(outputConfig)

"Information on where to store output Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.inspectJob.actions.saveFindings.outputConfig

"Information on where to store output Structure is documented below."

fn spec.initProvider.inspectJob.actions.saveFindings.outputConfig.withOutputSchema

withOutputSchema(outputSchema)

"Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the Finding object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. Possible values are: BASIC_COLUMNS, GCS_COLUMNS, DATASTORE_COLUMNS, BIG_QUERY_COLUMNS, ALL_COLUMNS."

fn spec.initProvider.inspectJob.actions.saveFindings.outputConfig.withTable

withTable(table)

"The BigQuery table in which to store the output. Structure is documented below."

fn spec.initProvider.inspectJob.actions.saveFindings.outputConfig.withTableMixin

withTableMixin(table)

"The BigQuery table in which to store the output. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.inspectJob.actions.saveFindings.outputConfig.table

"The BigQuery table in which to store the output. Structure is documented below."

fn spec.initProvider.inspectJob.actions.saveFindings.outputConfig.table.withDatasetId

withDatasetId(datasetId)

"The ID of the dataset containing this table."

fn spec.initProvider.inspectJob.actions.saveFindings.outputConfig.table.withProjectId

withProjectId(projectId)

"The ID of the project containing this table."

fn spec.initProvider.inspectJob.actions.saveFindings.outputConfig.table.withTableId

withTableId(tableId)

"The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters."

obj spec.initProvider.inspectJob.inspectConfig

"The core content of the template. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.withCustomInfoTypes

withCustomInfoTypes(customInfoTypes)

"Custom info types to be used. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.withCustomInfoTypesMixin

withCustomInfoTypesMixin(customInfoTypes)

"Custom info types to be used. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.inspectConfig.withExcludeInfoTypes

withExcludeInfoTypes(excludeInfoTypes)

"When true, excludes type information of the findings."

fn spec.initProvider.inspectJob.inspectConfig.withIncludeQuote

withIncludeQuote(includeQuote)

"When true, a contextual quote from the data that triggered a finding is included in the response."

fn spec.initProvider.inspectJob.inspectConfig.withInfoTypes

withInfoTypes(infoTypes)

"List of infoTypes this rule set is applied to. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.withInfoTypesMixin

withInfoTypesMixin(infoTypes)

"List of infoTypes this rule set is applied to. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.inspectConfig.withLimits

withLimits(limits)

"Configuration to control the number of findings returned. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.withLimitsMixin

withLimitsMixin(limits)

"Configuration to control the number of findings returned. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.inspectConfig.withMinLikelihood

withMinLikelihood(minLikelihood)

"Only returns findings equal or above this threshold. See https://cloud.google.com/dlp/docs/likelihood for more info Default value is POSSIBLE. Possible values are: VERY_UNLIKELY, UNLIKELY, POSSIBLE, LIKELY, VERY_LIKELY."

fn spec.initProvider.inspectJob.inspectConfig.withRuleSet

withRuleSet(ruleSet)

"Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.withRuleSetMixin

withRuleSetMixin(ruleSet)

"Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.inspectJob.inspectConfig.customInfoTypes

"Custom info types to be used. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.customInfoTypes.withDictionary

withDictionary(dictionary)

"Dictionary which defines the rule. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.customInfoTypes.withDictionaryMixin

withDictionaryMixin(dictionary)

"Dictionary which defines the rule. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.inspectConfig.customInfoTypes.withExclusionType

withExclusionType(exclusionType)

"If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Possible values are: EXCLUSION_TYPE_EXCLUDE."

fn spec.initProvider.inspectJob.inspectConfig.customInfoTypes.withInfoType

withInfoType(infoType)

"Type of information the findings limit applies to. Only one limit per infoType should be provided. If InfoTypeLimit does not have an infoType, the DLP API applies the limit against all infoTypes that are found but not specified in another InfoTypeLimit. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.customInfoTypes.withInfoTypeMixin

withInfoTypeMixin(infoType)

"Type of information the findings limit applies to. Only one limit per infoType should be provided. If InfoTypeLimit does not have an infoType, the DLP API applies the limit against all infoTypes that are found but not specified in another InfoTypeLimit. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.inspectConfig.customInfoTypes.withLikelihood

withLikelihood(likelihood)

"Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Default value is VERY_LIKELY. Possible values are: VERY_UNLIKELY, UNLIKELY, POSSIBLE, LIKELY, VERY_LIKELY."

fn spec.initProvider.inspectJob.inspectConfig.customInfoTypes.withRegex

withRegex(regex)

"Regular expression which defines the rule. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.customInfoTypes.withRegexMixin

withRegexMixin(regex)

"Regular expression which defines the rule. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.inspectConfig.customInfoTypes.withStoredType

withStoredType(storedType)

"A reference to a StoredInfoType to use with scanning. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.customInfoTypes.withStoredTypeMixin

withStoredTypeMixin(storedType)

"A reference to a StoredInfoType to use with scanning. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.inspectConfig.customInfoTypes.withSurrogateType

withSurrogateType(surrogateType)

"Message for detecting output from deidentification transformations that support reversing."

fn spec.initProvider.inspectJob.inspectConfig.customInfoTypes.withSurrogateTypeMixin

withSurrogateTypeMixin(surrogateType)

"Message for detecting output from deidentification transformations that support reversing."

Note: This function appends passed data to existing values

obj spec.initProvider.inspectJob.inspectConfig.customInfoTypes.dictionary

"Dictionary which defines the rule. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.customInfoTypes.dictionary.withCloudStoragePath

withCloudStoragePath(cloudStoragePath)

"Newline-delimited file of words in Cloud Storage. Only a single file is accepted. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.customInfoTypes.dictionary.withCloudStoragePathMixin

withCloudStoragePathMixin(cloudStoragePath)

"Newline-delimited file of words in Cloud Storage. Only a single file is accepted. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.inspectConfig.customInfoTypes.dictionary.withWordList

withWordList(wordList)

"List of words or phrases to search for. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.customInfoTypes.dictionary.withWordListMixin

withWordListMixin(wordList)

"List of words or phrases to search for. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.inspectJob.inspectConfig.customInfoTypes.dictionary.cloudStoragePath

"Newline-delimited file of words in Cloud Storage. Only a single file is accepted. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.customInfoTypes.dictionary.cloudStoragePath.withPath

withPath(path)

"A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt"

obj spec.initProvider.inspectJob.inspectConfig.customInfoTypes.dictionary.wordList

"List of words or phrases to search for. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.customInfoTypes.dictionary.wordList.withWords

withWords(words)

"Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits."

fn spec.initProvider.inspectJob.inspectConfig.customInfoTypes.dictionary.wordList.withWordsMixin

withWordsMixin(words)

"Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits."

Note: This function appends passed data to existing values

obj spec.initProvider.inspectJob.inspectConfig.customInfoTypes.infoType

"Type of information the findings limit applies to. Only one limit per infoType should be provided. If InfoTypeLimit does not have an infoType, the DLP API applies the limit against all infoTypes that are found but not specified in another InfoTypeLimit. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.customInfoTypes.infoType.withName

withName(name)

"Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: Required to filter out rows based on the given start and end times. If not specified and the table was modified between the given start and end times, the entire table will be scanned. The valid data types of the timestamp field are: INTEGER, DATE, TIMESTAMP, or DATETIME BigQuery column. For Datastore. Valid data types of the timestamp field are: TIMESTAMP. Datastore entity will be scanned if the timestamp property does not exist or its value is empty or invalid."

fn spec.initProvider.inspectJob.inspectConfig.customInfoTypes.infoType.withVersion

withVersion(version)

"Version of the information type to use. By default, the version is set to stable"

obj spec.initProvider.inspectJob.inspectConfig.customInfoTypes.regex

"Regular expression which defines the rule. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.customInfoTypes.regex.withGroupIndexes

withGroupIndexes(groupIndexes)

"The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included."

fn spec.initProvider.inspectJob.inspectConfig.customInfoTypes.regex.withGroupIndexesMixin

withGroupIndexesMixin(groupIndexes)

"The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.inspectConfig.customInfoTypes.regex.withPattern

withPattern(pattern)

"Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub."

obj spec.initProvider.inspectJob.inspectConfig.customInfoTypes.storedType

"A reference to a StoredInfoType to use with scanning. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.customInfoTypes.storedType.withName

withName(name)

"Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: Required to filter out rows based on the given start and end times. If not specified and the table was modified between the given start and end times, the entire table will be scanned. The valid data types of the timestamp field are: INTEGER, DATE, TIMESTAMP, or DATETIME BigQuery column. For Datastore. Valid data types of the timestamp field are: TIMESTAMP. Datastore entity will be scanned if the timestamp property does not exist or its value is empty or invalid."

obj spec.initProvider.inspectJob.inspectConfig.infoTypes

"List of infoTypes this rule set is applied to. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.infoTypes.withName

withName(name)

"Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: Required to filter out rows based on the given start and end times. If not specified and the table was modified between the given start and end times, the entire table will be scanned. The valid data types of the timestamp field are: INTEGER, DATE, TIMESTAMP, or DATETIME BigQuery column. For Datastore. Valid data types of the timestamp field are: TIMESTAMP. Datastore entity will be scanned if the timestamp property does not exist or its value is empty or invalid."

fn spec.initProvider.inspectJob.inspectConfig.infoTypes.withVersion

withVersion(version)

"Version of the information type to use. By default, the version is set to stable"

obj spec.initProvider.inspectJob.inspectConfig.limits

"Configuration to control the number of findings returned. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.limits.withMaxFindingsPerInfoType

withMaxFindingsPerInfoType(maxFindingsPerInfoType)

"Configuration of findings limit given for specified infoTypes. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.limits.withMaxFindingsPerInfoTypeMixin

withMaxFindingsPerInfoTypeMixin(maxFindingsPerInfoType)

"Configuration of findings limit given for specified infoTypes. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.inspectConfig.limits.withMaxFindingsPerItem

withMaxFindingsPerItem(maxFindingsPerItem)

"Max number of findings that will be returned for each item scanned. The maximum returned is 2000."

fn spec.initProvider.inspectJob.inspectConfig.limits.withMaxFindingsPerRequest

withMaxFindingsPerRequest(maxFindingsPerRequest)

"Max number of findings that will be returned per request/job. The maximum returned is 2000."

obj spec.initProvider.inspectJob.inspectConfig.limits.maxFindingsPerInfoType

"Configuration of findings limit given for specified infoTypes. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.limits.maxFindingsPerInfoType.withInfoType

withInfoType(infoType)

"Type of information the findings limit applies to. Only one limit per infoType should be provided. If InfoTypeLimit does not have an infoType, the DLP API applies the limit against all infoTypes that are found but not specified in another InfoTypeLimit. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.limits.maxFindingsPerInfoType.withInfoTypeMixin

withInfoTypeMixin(infoType)

"Type of information the findings limit applies to. Only one limit per infoType should be provided. If InfoTypeLimit does not have an infoType, the DLP API applies the limit against all infoTypes that are found but not specified in another InfoTypeLimit. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.inspectConfig.limits.maxFindingsPerInfoType.withMaxFindings

withMaxFindings(maxFindings)

"Max findings limit for the given infoType."

obj spec.initProvider.inspectJob.inspectConfig.limits.maxFindingsPerInfoType.infoType

"Type of information the findings limit applies to. Only one limit per infoType should be provided. If InfoTypeLimit does not have an infoType, the DLP API applies the limit against all infoTypes that are found but not specified in another InfoTypeLimit. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.limits.maxFindingsPerInfoType.infoType.withName

withName(name)

"Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: Required to filter out rows based on the given start and end times. If not specified and the table was modified between the given start and end times, the entire table will be scanned. The valid data types of the timestamp field are: INTEGER, DATE, TIMESTAMP, or DATETIME BigQuery column. For Datastore. Valid data types of the timestamp field are: TIMESTAMP. Datastore entity will be scanned if the timestamp property does not exist or its value is empty or invalid."

fn spec.initProvider.inspectJob.inspectConfig.limits.maxFindingsPerInfoType.infoType.withVersion

withVersion(version)

"Version of the information type to use. By default, the version is set to stable"

obj spec.initProvider.inspectJob.inspectConfig.ruleSet

"Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.withInfoTypes

withInfoTypes(infoTypes)

"List of infoTypes this rule set is applied to. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.withInfoTypesMixin

withInfoTypesMixin(infoTypes)

"List of infoTypes this rule set is applied to. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.withRules

withRules(rules)

"Set of rules to be applied to infoTypes. The rules are applied in order. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.withRulesMixin

withRulesMixin(rules)

"Set of rules to be applied to infoTypes. The rules are applied in order. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.inspectJob.inspectConfig.ruleSet.infoTypes

"List of infoTypes this rule set is applied to. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.infoTypes.withName

withName(name)

"Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: Required to filter out rows based on the given start and end times. If not specified and the table was modified between the given start and end times, the entire table will be scanned. The valid data types of the timestamp field are: INTEGER, DATE, TIMESTAMP, or DATETIME BigQuery column. For Datastore. Valid data types of the timestamp field are: TIMESTAMP. Datastore entity will be scanned if the timestamp property does not exist or its value is empty or invalid."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.infoTypes.withVersion

withVersion(version)

"Version of the information type to use. By default, the version is set to stable"

obj spec.initProvider.inspectJob.inspectConfig.ruleSet.rules

"Set of rules to be applied to infoTypes. The rules are applied in order. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.withExclusionRule

withExclusionRule(exclusionRule)

"The rule that specifies conditions when findings of infoTypes specified in InspectionRuleSet are removed from results. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.withExclusionRuleMixin

withExclusionRuleMixin(exclusionRule)

"The rule that specifies conditions when findings of infoTypes specified in InspectionRuleSet are removed from results. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.withHotwordRule

withHotwordRule(hotwordRule)

"Hotword-based detection rule. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.withHotwordRuleMixin

withHotwordRuleMixin(hotwordRule)

"Hotword-based detection rule. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule

"The rule that specifies conditions when findings of infoTypes specified in InspectionRuleSet are removed from results. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.withDictionary

withDictionary(dictionary)

"Dictionary which defines the rule. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.withDictionaryMixin

withDictionaryMixin(dictionary)

"Dictionary which defines the rule. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.withExcludeByHotword

withExcludeByHotword(excludeByHotword)

"Drop if the hotword rule is contained in the proximate context. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.withExcludeByHotwordMixin

withExcludeByHotwordMixin(excludeByHotword)

"Drop if the hotword rule is contained in the proximate context. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.withExcludeInfoTypes

withExcludeInfoTypes(excludeInfoTypes)

"When true, excludes type information of the findings."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.withExcludeInfoTypesMixin

withExcludeInfoTypesMixin(excludeInfoTypes)

"When true, excludes type information of the findings."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.withMatchingType

withMatchingType(matchingType)

"How the rule is applied. See the documentation for more information: https://cloud.google.com/dlp/docs/reference/rest/v2/InspectConfig#MatchingType Possible values are: MATCHING_TYPE_FULL_MATCH, MATCHING_TYPE_PARTIAL_MATCH, MATCHING_TYPE_INVERSE_MATCH."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.withRegex

withRegex(regex)

"Regular expression which defines the rule. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.withRegexMixin

withRegexMixin(regex)

"Regular expression which defines the rule. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.dictionary

"Dictionary which defines the rule. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.dictionary.withCloudStoragePath

withCloudStoragePath(cloudStoragePath)

"Newline-delimited file of words in Cloud Storage. Only a single file is accepted. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.dictionary.withCloudStoragePathMixin

withCloudStoragePathMixin(cloudStoragePath)

"Newline-delimited file of words in Cloud Storage. Only a single file is accepted. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.dictionary.withWordList

withWordList(wordList)

"List of words or phrases to search for. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.dictionary.withWordListMixin

withWordListMixin(wordList)

"List of words or phrases to search for. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.dictionary.cloudStoragePath

"Newline-delimited file of words in Cloud Storage. Only a single file is accepted. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.dictionary.cloudStoragePath.withPath

withPath(path)

"A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt"

obj spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.dictionary.wordList

"List of words or phrases to search for. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.dictionary.wordList.withWords

withWords(words)

"Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.dictionary.wordList.withWordsMixin

withWordsMixin(words)

"Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits."

Note: This function appends passed data to existing values

obj spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeByHotword

"Drop if the hotword rule is contained in the proximate context. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeByHotword.withHotwordRegex

withHotwordRegex(hotwordRegex)

"Regular expression pattern defining what qualifies as a hotword. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeByHotword.withHotwordRegexMixin

withHotwordRegexMixin(hotwordRegex)

"Regular expression pattern defining what qualifies as a hotword. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeByHotword.withProximity

withProximity(proximity)

"Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex (\d{3}) \d{3}-\d{4} could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex (xxx), where xxx is the area code in question. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeByHotword.withProximityMixin

withProximityMixin(proximity)

"Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex (\d{3}) \d{3}-\d{4} could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex (xxx), where xxx is the area code in question. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeByHotword.hotwordRegex

"Regular expression pattern defining what qualifies as a hotword. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeByHotword.hotwordRegex.withGroupIndexes

withGroupIndexes(groupIndexes)

"The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeByHotword.hotwordRegex.withGroupIndexesMixin

withGroupIndexesMixin(groupIndexes)

"The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeByHotword.hotwordRegex.withPattern

withPattern(pattern)

"Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub."

obj spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeByHotword.proximity

"Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex (\d{3}) \d{3}-\d{4} could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex (xxx), where xxx is the area code in question. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeByHotword.proximity.withWindowAfter

withWindowAfter(windowAfter)

"Number of characters after the finding to consider. Either this or window_before must be specified"

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeByHotword.proximity.withWindowBefore

withWindowBefore(windowBefore)

"Number of characters before the finding to consider. Either this or window_after must be specified"

obj spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeInfoTypes

"When true, excludes type information of the findings."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeInfoTypes.withInfoTypes

withInfoTypes(infoTypes)

"List of infoTypes this rule set is applied to. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeInfoTypes.withInfoTypesMixin

withInfoTypesMixin(infoTypes)

"List of infoTypes this rule set is applied to. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeInfoTypes.infoTypes

"List of infoTypes this rule set is applied to. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeInfoTypes.infoTypes.withName

withName(name)

"Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: Required to filter out rows based on the given start and end times. If not specified and the table was modified between the given start and end times, the entire table will be scanned. The valid data types of the timestamp field are: INTEGER, DATE, TIMESTAMP, or DATETIME BigQuery column. For Datastore. Valid data types of the timestamp field are: TIMESTAMP. Datastore entity will be scanned if the timestamp property does not exist or its value is empty or invalid."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.excludeInfoTypes.infoTypes.withVersion

withVersion(version)

"Version of the information type to use. By default, the version is set to stable"

obj spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.regex

"Regular expression which defines the rule. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.regex.withGroupIndexes

withGroupIndexes(groupIndexes)

"The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.regex.withGroupIndexesMixin

withGroupIndexesMixin(groupIndexes)

"The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.exclusionRule.regex.withPattern

withPattern(pattern)

"Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub."

obj spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule

"Hotword-based detection rule. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.withHotwordRegex

withHotwordRegex(hotwordRegex)

"Regular expression pattern defining what qualifies as a hotword. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.withHotwordRegexMixin

withHotwordRegexMixin(hotwordRegex)

"Regular expression pattern defining what qualifies as a hotword. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.withLikelihoodAdjustment

withLikelihoodAdjustment(likelihoodAdjustment)

"Likelihood adjustment to apply to all matching findings. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.withLikelihoodAdjustmentMixin

withLikelihoodAdjustmentMixin(likelihoodAdjustment)

"Likelihood adjustment to apply to all matching findings. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.withProximity

withProximity(proximity)

"Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex (\d{3}) \d{3}-\d{4} could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex (xxx), where xxx is the area code in question. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.withProximityMixin

withProximityMixin(proximity)

"Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex (\d{3}) \d{3}-\d{4} could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex (xxx), where xxx is the area code in question. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.hotwordRegex

"Regular expression pattern defining what qualifies as a hotword. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.hotwordRegex.withGroupIndexes

withGroupIndexes(groupIndexes)

"The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.hotwordRegex.withGroupIndexesMixin

withGroupIndexesMixin(groupIndexes)

"The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.hotwordRegex.withPattern

withPattern(pattern)

"Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub."

obj spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.likelihoodAdjustment

"Likelihood adjustment to apply to all matching findings. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.likelihoodAdjustment.withFixedLikelihood

withFixedLikelihood(fixedLikelihood)

"Set the likelihood of a finding to a fixed value. Either this or relative_likelihood can be set. Possible values are: VERY_UNLIKELY, UNLIKELY, POSSIBLE, LIKELY, VERY_LIKELY."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.likelihoodAdjustment.withRelativeLikelihood

withRelativeLikelihood(relativeLikelihood)

"Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be POSSIBLE without the detection rule and relativeLikelihood is 1, then it is upgraded to LIKELY, while a value of -1 would downgrade it to UNLIKELY. Likelihood may never drop below VERY_UNLIKELY or exceed VERY_LIKELY, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is VERY_LIKELY will result in a final likelihood of LIKELY. Either this or fixed_likelihood can be set."

obj spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.proximity

"Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex (\d{3}) \d{3}-\d{4} could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex (xxx), where xxx is the area code in question. Structure is documented below."

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.proximity.withWindowAfter

withWindowAfter(windowAfter)

"Number of characters after the finding to consider. Either this or window_before must be specified"

fn spec.initProvider.inspectJob.inspectConfig.ruleSet.rules.hotwordRule.proximity.withWindowBefore

withWindowBefore(windowBefore)

"Number of characters before the finding to consider. Either this or window_after must be specified"

obj spec.initProvider.inspectJob.storageConfig

"Information on where to inspect Structure is documented below."

fn spec.initProvider.inspectJob.storageConfig.withBigQueryOptions

withBigQueryOptions(bigQueryOptions)

"Options defining BigQuery table and row identifiers. Structure is documented below."

fn spec.initProvider.inspectJob.storageConfig.withBigQueryOptionsMixin

withBigQueryOptionsMixin(bigQueryOptions)

"Options defining BigQuery table and row identifiers. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.storageConfig.withCloudStorageOptions

withCloudStorageOptions(cloudStorageOptions)

"Options defining a file or a set of files within a Google Cloud Storage bucket. Structure is documented below."

fn spec.initProvider.inspectJob.storageConfig.withCloudStorageOptionsMixin

withCloudStorageOptionsMixin(cloudStorageOptions)

"Options defining a file or a set of files within a Google Cloud Storage bucket. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.storageConfig.withDatastoreOptions

withDatastoreOptions(datastoreOptions)

"Options defining a data set within Google Cloud Datastore. Structure is documented below."

fn spec.initProvider.inspectJob.storageConfig.withDatastoreOptionsMixin

withDatastoreOptionsMixin(datastoreOptions)

"Options defining a data set within Google Cloud Datastore. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.storageConfig.withHybridOptions

withHybridOptions(hybridOptions)

"Configuration to control jobs where the content being inspected is outside of Google Cloud Platform. Structure is documented below."

fn spec.initProvider.inspectJob.storageConfig.withHybridOptionsMixin

withHybridOptionsMixin(hybridOptions)

"Configuration to control jobs where the content being inspected is outside of Google Cloud Platform. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.storageConfig.withTimespanConfig

withTimespanConfig(timespanConfig)

"Information on where to inspect Structure is documented below."

fn spec.initProvider.inspectJob.storageConfig.withTimespanConfigMixin

withTimespanConfigMixin(timespanConfig)

"Information on where to inspect Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.inspectJob.storageConfig.bigQueryOptions

"Options defining BigQuery table and row identifiers. Structure is documented below."

fn spec.initProvider.inspectJob.storageConfig.bigQueryOptions.withIdentifyingFields

withIdentifyingFields(identifyingFields)

"The columns that are the primary keys for table objects included in ContentItem. A copy of this cell's value will stored alongside alongside each finding so that the finding can be traced to the specific row it came from. No more than 3 may be provided. Structure is documented below."

fn spec.initProvider.inspectJob.storageConfig.bigQueryOptions.withIdentifyingFieldsMixin

withIdentifyingFieldsMixin(identifyingFields)

"The columns that are the primary keys for table objects included in ContentItem. A copy of this cell's value will stored alongside alongside each finding so that the finding can be traced to the specific row it came from. No more than 3 may be provided. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.storageConfig.bigQueryOptions.withRowsLimit

withRowsLimit(rowsLimit)

"Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rowsLimit and rowsLimitPercent can be specified. Cannot be used in conjunction with TimespanConfig."

fn spec.initProvider.inspectJob.storageConfig.bigQueryOptions.withRowsLimitPercent

withRowsLimitPercent(rowsLimitPercent)

"Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rowsLimit and rowsLimitPercent can be specified. Cannot be used in conjunction with TimespanConfig."

fn spec.initProvider.inspectJob.storageConfig.bigQueryOptions.withSampleMethod

withSampleMethod(sampleMethod)

"How to sample bytes if not all bytes are scanned. Meaningful only when used in conjunction with bytesLimitPerFile. If not specified, scanning would start from the top. Possible values are: TOP, RANDOM_START."

fn spec.initProvider.inspectJob.storageConfig.bigQueryOptions.withTableReference

withTableReference(tableReference)

"Set of files to scan. Structure is documented below."

fn spec.initProvider.inspectJob.storageConfig.bigQueryOptions.withTableReferenceMixin

withTableReferenceMixin(tableReference)

"Set of files to scan. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.inspectJob.storageConfig.bigQueryOptions.identifyingFields

"The columns that are the primary keys for table objects included in ContentItem. A copy of this cell's value will stored alongside alongside each finding so that the finding can be traced to the specific row it came from. No more than 3 may be provided. Structure is documented below."

fn spec.initProvider.inspectJob.storageConfig.bigQueryOptions.identifyingFields.withName

withName(name)

"Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: Required to filter out rows based on the given start and end times. If not specified and the table was modified between the given start and end times, the entire table will be scanned. The valid data types of the timestamp field are: INTEGER, DATE, TIMESTAMP, or DATETIME BigQuery column. For Datastore. Valid data types of the timestamp field are: TIMESTAMP. Datastore entity will be scanned if the timestamp property does not exist or its value is empty or invalid."

obj spec.initProvider.inspectJob.storageConfig.bigQueryOptions.tableReference

"Set of files to scan. Structure is documented below."

fn spec.initProvider.inspectJob.storageConfig.bigQueryOptions.tableReference.withDatasetId

withDatasetId(datasetId)

"The ID of the dataset containing this table."

fn spec.initProvider.inspectJob.storageConfig.bigQueryOptions.tableReference.withProjectId

withProjectId(projectId)

"The ID of the project containing this table."

fn spec.initProvider.inspectJob.storageConfig.bigQueryOptions.tableReference.withTableId

withTableId(tableId)

"The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters."

obj spec.initProvider.inspectJob.storageConfig.cloudStorageOptions

"Options defining a file or a set of files within a Google Cloud Storage bucket. Structure is documented below."

fn spec.initProvider.inspectJob.storageConfig.cloudStorageOptions.withBytesLimitPerFile

withBytesLimitPerFile(bytesLimitPerFile)

"Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted."

fn spec.initProvider.inspectJob.storageConfig.cloudStorageOptions.withBytesLimitPerFilePercent

withBytesLimitPerFilePercent(bytesLimitPerFilePercent)

"Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit."

fn spec.initProvider.inspectJob.storageConfig.cloudStorageOptions.withFileSet

withFileSet(fileSet)

"Set of files to scan. Structure is documented below."

fn spec.initProvider.inspectJob.storageConfig.cloudStorageOptions.withFileSetMixin

withFileSetMixin(fileSet)

"Set of files to scan. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.storageConfig.cloudStorageOptions.withFileTypes

withFileTypes(fileTypes)

"List of file type groups to include in the scan. If empty, all files are scanned and available data format processors are applied. In addition, the binary content of the selected files is always scanned as well. Images are scanned only as binary if the specified region does not support image inspection and no fileTypes were specified. Each value may be one of: BINARY_FILE, TEXT_FILE, IMAGE, WORD, PDF, AVRO, CSV, TSV."

fn spec.initProvider.inspectJob.storageConfig.cloudStorageOptions.withFileTypesMixin

withFileTypesMixin(fileTypes)

"List of file type groups to include in the scan. If empty, all files are scanned and available data format processors are applied. In addition, the binary content of the selected files is always scanned as well. Images are scanned only as binary if the specified region does not support image inspection and no fileTypes were specified. Each value may be one of: BINARY_FILE, TEXT_FILE, IMAGE, WORD, PDF, AVRO, CSV, TSV."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.storageConfig.cloudStorageOptions.withFilesLimitPercent

withFilesLimitPercent(filesLimitPercent)

"Limits the number of files to scan to this percentage of the input FileSet. Number of files scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit."

fn spec.initProvider.inspectJob.storageConfig.cloudStorageOptions.withSampleMethod

withSampleMethod(sampleMethod)

"How to sample bytes if not all bytes are scanned. Meaningful only when used in conjunction with bytesLimitPerFile. If not specified, scanning would start from the top. Possible values are: TOP, RANDOM_START."

obj spec.initProvider.inspectJob.storageConfig.cloudStorageOptions.fileSet

"Set of files to scan. Structure is documented below."

fn spec.initProvider.inspectJob.storageConfig.cloudStorageOptions.fileSet.withRegexFileSet

withRegexFileSet(regexFileSet)

"The regex-filtered set of files to scan. Structure is documented below."

fn spec.initProvider.inspectJob.storageConfig.cloudStorageOptions.fileSet.withRegexFileSetMixin

withRegexFileSetMixin(regexFileSet)

"The regex-filtered set of files to scan. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.storageConfig.cloudStorageOptions.fileSet.withUrl

withUrl(url)

"The Cloud Storage url of the file(s) to scan, in the format gs:///. Trailing wildcard in the path is allowed. If the url ends in a trailing slash, the bucket or directory represented by the url will be scanned non-recursively (content in sub-directories will not be scanned). This means that gs://mybucket/ is equivalent to gs://mybucket/, and gs://mybucket/directory/ is equivalent to gs://mybucket/directory/."

obj spec.initProvider.inspectJob.storageConfig.cloudStorageOptions.fileSet.regexFileSet

"The regex-filtered set of files to scan. Structure is documented below."

fn spec.initProvider.inspectJob.storageConfig.cloudStorageOptions.fileSet.regexFileSet.withBucketName

withBucketName(bucketName)

"The name of a Cloud Storage bucket."

fn spec.initProvider.inspectJob.storageConfig.cloudStorageOptions.fileSet.regexFileSet.withExcludeRegex

withExcludeRegex(excludeRegex)

"A list of regular expressions matching file paths to exclude. All files in the bucket that match at least one of these regular expressions will be excluded from the scan."

fn spec.initProvider.inspectJob.storageConfig.cloudStorageOptions.fileSet.regexFileSet.withExcludeRegexMixin

withExcludeRegexMixin(excludeRegex)

"A list of regular expressions matching file paths to exclude. All files in the bucket that match at least one of these regular expressions will be excluded from the scan."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.storageConfig.cloudStorageOptions.fileSet.regexFileSet.withIncludeRegex

withIncludeRegex(includeRegex)

"A list of regular expressions matching file paths to include. All files in the bucket that match at least one of these regular expressions will be included in the set of files, except for those that also match an item in excludeRegex. Leaving this field empty will match all files by default (this is equivalent to including .* in the list)"

fn spec.initProvider.inspectJob.storageConfig.cloudStorageOptions.fileSet.regexFileSet.withIncludeRegexMixin

withIncludeRegexMixin(includeRegex)

"A list of regular expressions matching file paths to include. All files in the bucket that match at least one of these regular expressions will be included in the set of files, except for those that also match an item in excludeRegex. Leaving this field empty will match all files by default (this is equivalent to including .* in the list)"

Note: This function appends passed data to existing values

obj spec.initProvider.inspectJob.storageConfig.datastoreOptions

"Options defining a data set within Google Cloud Datastore. Structure is documented below."

fn spec.initProvider.inspectJob.storageConfig.datastoreOptions.withKind

withKind(kind)

"A representation of a Datastore kind. Structure is documented below."

fn spec.initProvider.inspectJob.storageConfig.datastoreOptions.withKindMixin

withKindMixin(kind)

"A representation of a Datastore kind. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.storageConfig.datastoreOptions.withPartitionId

withPartitionId(partitionId)

"Datastore partition ID. A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. Structure is documented below."

fn spec.initProvider.inspectJob.storageConfig.datastoreOptions.withPartitionIdMixin

withPartitionIdMixin(partitionId)

"Datastore partition ID. A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.inspectJob.storageConfig.datastoreOptions.kind

"A representation of a Datastore kind. Structure is documented below."

fn spec.initProvider.inspectJob.storageConfig.datastoreOptions.kind.withName

withName(name)

"Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: Required to filter out rows based on the given start and end times. If not specified and the table was modified between the given start and end times, the entire table will be scanned. The valid data types of the timestamp field are: INTEGER, DATE, TIMESTAMP, or DATETIME BigQuery column. For Datastore. Valid data types of the timestamp field are: TIMESTAMP. Datastore entity will be scanned if the timestamp property does not exist or its value is empty or invalid."

obj spec.initProvider.inspectJob.storageConfig.datastoreOptions.partitionId

"Datastore partition ID. A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. Structure is documented below."

fn spec.initProvider.inspectJob.storageConfig.datastoreOptions.partitionId.withNamespaceId

withNamespaceId(namespaceId)

"If not empty, the ID of the namespace to which the entities belong."

fn spec.initProvider.inspectJob.storageConfig.datastoreOptions.partitionId.withProjectId

withProjectId(projectId)

"The ID of the project containing this table."

obj spec.initProvider.inspectJob.storageConfig.hybridOptions

"Configuration to control jobs where the content being inspected is outside of Google Cloud Platform. Structure is documented below."

fn spec.initProvider.inspectJob.storageConfig.hybridOptions.withDescription

withDescription(description)

"A description of the job trigger."

fn spec.initProvider.inspectJob.storageConfig.hybridOptions.withLabels

withLabels(labels)

"To organize findings, these labels will be added to each finding. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?. No more than 10 labels can be associated with a given finding. Examples:"

fn spec.initProvider.inspectJob.storageConfig.hybridOptions.withLabelsMixin

withLabelsMixin(labels)

"To organize findings, these labels will be added to each finding. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?. No more than 10 labels can be associated with a given finding. Examples:"

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.storageConfig.hybridOptions.withRequiredFindingLabelKeys

withRequiredFindingLabelKeys(requiredFindingLabelKeys)

"These are labels that each inspection request must include within their 'finding_labels' map. Request may contain others, but any missing one of these will be rejected. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. No more than 10 keys can be required."

fn spec.initProvider.inspectJob.storageConfig.hybridOptions.withRequiredFindingLabelKeysMixin

withRequiredFindingLabelKeysMixin(requiredFindingLabelKeys)

"These are labels that each inspection request must include within their 'finding_labels' map. Request may contain others, but any missing one of these will be rejected. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. No more than 10 keys can be required."

Note: This function appends passed data to existing values

fn spec.initProvider.inspectJob.storageConfig.hybridOptions.withTableOptions

withTableOptions(tableOptions)

"If the container is a table, additional information to make findings meaningful such as the columns that are primary keys. Structure is documented below."

fn spec.initProvider.inspectJob.storageConfig.hybridOptions.withTableOptionsMixin

withTableOptionsMixin(tableOptions)

"If the container is a table, additional information to make findings meaningful such as the columns that are primary keys. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.inspectJob.storageConfig.hybridOptions.tableOptions

"If the container is a table, additional information to make findings meaningful such as the columns that are primary keys. Structure is documented below."

fn spec.initProvider.inspectJob.storageConfig.hybridOptions.tableOptions.withIdentifyingFields

withIdentifyingFields(identifyingFields)

"The columns that are the primary keys for table objects included in ContentItem. A copy of this cell's value will stored alongside alongside each finding so that the finding can be traced to the specific row it came from. No more than 3 may be provided. Structure is documented below."

fn spec.initProvider.inspectJob.storageConfig.hybridOptions.tableOptions.withIdentifyingFieldsMixin

withIdentifyingFieldsMixin(identifyingFields)

"The columns that are the primary keys for table objects included in ContentItem. A copy of this cell's value will stored alongside alongside each finding so that the finding can be traced to the specific row it came from. No more than 3 may be provided. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.inspectJob.storageConfig.hybridOptions.tableOptions.identifyingFields

"The columns that are the primary keys for table objects included in ContentItem. A copy of this cell's value will stored alongside alongside each finding so that the finding can be traced to the specific row it came from. No more than 3 may be provided. Structure is documented below."

fn spec.initProvider.inspectJob.storageConfig.hybridOptions.tableOptions.identifyingFields.withName

withName(name)

"Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: Required to filter out rows based on the given start and end times. If not specified and the table was modified between the given start and end times, the entire table will be scanned. The valid data types of the timestamp field are: INTEGER, DATE, TIMESTAMP, or DATETIME BigQuery column. For Datastore. Valid data types of the timestamp field are: TIMESTAMP. Datastore entity will be scanned if the timestamp property does not exist or its value is empty or invalid."

obj spec.initProvider.inspectJob.storageConfig.timespanConfig

"Information on where to inspect Structure is documented below."

fn spec.initProvider.inspectJob.storageConfig.timespanConfig.withEnableAutoPopulationOfTimespanConfig

withEnableAutoPopulationOfTimespanConfig(enableAutoPopulationOfTimespanConfig)

"When the job is started by a JobTrigger we will automatically figure out a valid startTime to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger."

fn spec.initProvider.inspectJob.storageConfig.timespanConfig.withEndTime

withEndTime(endTime)

"Exclude files or rows newer than this value. If set to zero, no upper time limit is applied."

fn spec.initProvider.inspectJob.storageConfig.timespanConfig.withStartTime

withStartTime(startTime)

"Exclude files or rows older than this value."

fn spec.initProvider.inspectJob.storageConfig.timespanConfig.withTimestampField

withTimestampField(timestampField)

"Information on where to inspect Structure is documented below."

fn spec.initProvider.inspectJob.storageConfig.timespanConfig.withTimestampFieldMixin

withTimestampFieldMixin(timestampField)

"Information on where to inspect Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.inspectJob.storageConfig.timespanConfig.timestampField

"Information on where to inspect Structure is documented below."

fn spec.initProvider.inspectJob.storageConfig.timespanConfig.timestampField.withName

withName(name)

"Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: Required to filter out rows based on the given start and end times. If not specified and the table was modified between the given start and end times, the entire table will be scanned. The valid data types of the timestamp field are: INTEGER, DATE, TIMESTAMP, or DATETIME BigQuery column. For Datastore. Valid data types of the timestamp field are: TIMESTAMP. Datastore entity will be scanned if the timestamp property does not exist or its value is empty or invalid."

obj spec.initProvider.triggers

"What event needs to occur for a new job to be started. Structure is documented below."

fn spec.initProvider.triggers.withManual

withManual(manual)

"For use with hybrid jobs. Jobs must be manually created and finished."

fn spec.initProvider.triggers.withManualMixin

withManualMixin(manual)

"For use with hybrid jobs. Jobs must be manually created and finished."

Note: This function appends passed data to existing values

fn spec.initProvider.triggers.withSchedule

withSchedule(schedule)

"Schedule for triggered jobs Structure is documented below."

fn spec.initProvider.triggers.withScheduleMixin

withScheduleMixin(schedule)

"Schedule for triggered jobs Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.triggers.schedule

"Schedule for triggered jobs Structure is documented below."

fn spec.initProvider.triggers.schedule.withRecurrencePeriodDuration

withRecurrencePeriodDuration(recurrencePeriodDuration)

"With this option a job is started a regular periodic basis. For example: every day (86400 seconds). A scheduled start time will be skipped if the previous execution has not ended when its scheduled time occurs. This value must be set to a time duration greater than or equal to 1 day and can be no longer than 60 days. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: \"3.5s\"."

obj spec.providerConfigRef

"ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured."

fn spec.providerConfigRef.withName

withName(name)

"Name of the referenced object."

obj spec.providerConfigRef.policy

"Policies for referencing."

fn spec.providerConfigRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.providerConfigRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.providerRef

"ProviderReference specifies the provider that will be used to create, observe, update, and delete this managed resource. Deprecated: Please use ProviderConfigReference, i.e. providerConfigRef"

fn spec.providerRef.withName

withName(name)

"Name of the referenced object."

obj spec.providerRef.policy

"Policies for referencing."

fn spec.providerRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.providerRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.publishConnectionDetailsTo

"PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource."

fn spec.publishConnectionDetailsTo.withName

withName(name)

"Name is the name of the connection secret."

obj spec.publishConnectionDetailsTo.configRef

"SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret."

fn spec.publishConnectionDetailsTo.configRef.withName

withName(name)

"Name of the referenced object."

obj spec.publishConnectionDetailsTo.configRef.policy

"Policies for referencing."

fn spec.publishConnectionDetailsTo.configRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.publishConnectionDetailsTo.configRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.publishConnectionDetailsTo.metadata

"Metadata is the metadata for connection secret."

fn spec.publishConnectionDetailsTo.metadata.withAnnotations

withAnnotations(annotations)

"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."

fn spec.publishConnectionDetailsTo.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."

Note: This function appends passed data to existing values

fn spec.publishConnectionDetailsTo.metadata.withLabels

withLabels(labels)

"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."

fn spec.publishConnectionDetailsTo.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."

Note: This function appends passed data to existing values

fn spec.publishConnectionDetailsTo.metadata.withType

withType(type)

"Type is the SecretType for the connection secret. - Only valid for Kubernetes Secret Stores."

obj spec.writeConnectionSecretToRef

"WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other."

fn spec.writeConnectionSecretToRef.withName

withName(name)

"Name of the secret."

fn spec.writeConnectionSecretToRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."