Class CreateDlpJobRequest (3.58.0) 

public final class CreateDlpJobRequest extends GeneratedMessageV3 implements CreateDlpJobRequestOrBuilder

Request message for CreateDlpJobRequest. Used to initiate long running jobs such as calculating risk metrics or inspecting Google Cloud Storage.

Protobuf type google.privacy.dlp.v2.CreateDlpJobRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CreateDlpJobRequest

Static Fields

INSPECT_JOB_FIELD_NUMBER

public static final int INSPECT_JOB_FIELD_NUMBER
Field Value
Type Description
int

JOB_ID_FIELD_NUMBER

public static final int JOB_ID_FIELD_NUMBER
Field Value
Type Description
int

LOCATION_ID_FIELD_NUMBER

public static final int LOCATION_ID_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

RISK_JOB_FIELD_NUMBER

public static final int RISK_JOB_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreateDlpJobRequest getDefaultInstance()
Returns
Type Description
CreateDlpJobRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CreateDlpJobRequest.Builder newBuilder()
Returns
Type Description
CreateDlpJobRequest.Builder

newBuilder(CreateDlpJobRequest prototype)

public static CreateDlpJobRequest.Builder newBuilder(CreateDlpJobRequest prototype)
Parameter
Name Description
prototype CreateDlpJobRequest
Returns
Type Description
CreateDlpJobRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateDlpJobRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateDlpJobRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateDlpJobRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateDlpJobRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CreateDlpJobRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CreateDlpJobRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateDlpJobRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateDlpJobRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateDlpJobRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CreateDlpJobRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateDlpJobRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateDlpJobRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateDlpJobRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CreateDlpJobRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateDlpJobRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateDlpJobRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CreateDlpJobRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateDlpJobRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateDlpJobRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateDlpJobRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CreateDlpJobRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CreateDlpJobRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateDlpJobRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateDlpJobRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CreateDlpJobRequest> parser()
Returns
Type Description
Parser<CreateDlpJobRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public CreateDlpJobRequest getDefaultInstanceForType()
Returns
Type Description
CreateDlpJobRequest

getInspectJob()

public InspectJobConfig getInspectJob()

An inspection job scans a storage repository for InfoTypes.

.google.privacy.dlp.v2.InspectJobConfig inspect_job = 2;

Returns
Type Description
InspectJobConfig

The inspectJob.

getInspectJobOrBuilder()

public InspectJobConfigOrBuilder getInspectJobOrBuilder()

An inspection job scans a storage repository for InfoTypes.

.google.privacy.dlp.v2.InspectJobConfig inspect_job = 2;

Returns
Type Description
InspectJobConfigOrBuilder

getJobCase()

public CreateDlpJobRequest.JobCase getJobCase()
Returns
Type Description
CreateDlpJobRequest.JobCase

getJobId()

public String getJobId()

The job id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: [a-zA-Z\d-_]+. The maximum length is 100 characters. Can be empty to allow the system to generate one.

string job_id = 4;

Returns
Type Description
String

The jobId.

getJobIdBytes()

public ByteString getJobIdBytes()

The job id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: [a-zA-Z\d-_]+. The maximum length is 100 characters. Can be empty to allow the system to generate one.

string job_id = 4;

Returns
Type Description
ByteString

The bytes for jobId.

getLocationId()

public String getLocationId()

Deprecated. This field has no effect.

string location_id = 5;

Returns
Type Description
String

The locationId.

getLocationIdBytes()

public ByteString getLocationIdBytes()

Deprecated. This field has no effect.

string location_id = 5;

Returns
Type Description
ByteString

The bytes for locationId.

getParent()

public String getParent()

Required. Parent resource name.

The format of this value varies depending on whether you have specified a processing location:

  • Projects scope, location specified: projects/{project_id}/locations/{location_id}

  • Projects scope, no location specified (defaults to global): projects/{project_id}

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. Parent resource name.

The format of this value varies depending on whether you have specified a processing location:

  • Projects scope, location specified: projects/{project_id}/locations/{location_id}

  • Projects scope, no location specified (defaults to global): projects/{project_id}

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<CreateDlpJobRequest> getParserForType()
Returns
Type Description
Parser<CreateDlpJobRequest>
Overrides

getRiskJob()

public RiskAnalysisJobConfig getRiskJob()

A risk analysis job calculates re-identification risk metrics for a BigQuery table.

.google.privacy.dlp.v2.RiskAnalysisJobConfig risk_job = 3;

Returns
Type Description
RiskAnalysisJobConfig

The riskJob.

getRiskJobOrBuilder()

public RiskAnalysisJobConfigOrBuilder getRiskJobOrBuilder()

A risk analysis job calculates re-identification risk metrics for a BigQuery table.

.google.privacy.dlp.v2.RiskAnalysisJobConfig risk_job = 3;

Returns
Type Description
RiskAnalysisJobConfigOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasInspectJob()

public boolean hasInspectJob()

An inspection job scans a storage repository for InfoTypes.

.google.privacy.dlp.v2.InspectJobConfig inspect_job = 2;

Returns
Type Description
boolean

Whether the inspectJob field is set.

hasRiskJob()

public boolean hasRiskJob()

A risk analysis job calculates re-identification risk metrics for a BigQuery table.

.google.privacy.dlp.v2.RiskAnalysisJobConfig risk_job = 3;

Returns
Type Description
boolean

Whether the riskJob field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CreateDlpJobRequest.Builder newBuilderForType()
Returns
Type Description
CreateDlpJobRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateDlpJobRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CreateDlpJobRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CreateDlpJobRequest.Builder toBuilder()
Returns
Type Description
CreateDlpJobRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException