Class CreateDlpJobRequest (3.26.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

Static Fields

INSPECT_JOB_FIELD_NUMBER

public static final int INSPECT_JOB_FIELD_NUMBER
Field Value
TypeDescription
int

JOB_ID_FIELD_NUMBER

public static final int JOB_ID_FIELD_NUMBER
Field Value
TypeDescription
int

LOCATION_ID_FIELD_NUMBER

public static final int LOCATION_ID_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

RISK_JOB_FIELD_NUMBER

public static final int RISK_JOB_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CreateDlpJobRequest getDefaultInstance()
Returns
TypeDescription
CreateDlpJobRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static CreateDlpJobRequest.Builder newBuilder()
Returns
TypeDescription
CreateDlpJobRequest.Builder

newBuilder(CreateDlpJobRequest prototype)

public static CreateDlpJobRequest.Builder newBuilder(CreateDlpJobRequest prototype)
Parameter
NameDescription
prototypeCreateDlpJobRequest
Returns
TypeDescription
CreateDlpJobRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateDlpJobRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateDlpJobRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateDlpJobRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateDlpJobRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CreateDlpJobRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CreateDlpJobRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateDlpJobRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateDlpJobRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateDlpJobRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CreateDlpJobRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateDlpJobRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateDlpJobRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateDlpJobRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CreateDlpJobRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateDlpJobRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateDlpJobRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CreateDlpJobRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateDlpJobRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateDlpJobRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateDlpJobRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CreateDlpJobRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CreateDlpJobRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateDlpJobRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateDlpJobRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CreateDlpJobRequest> parser()
Returns
TypeDescription
Parser<CreateDlpJobRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public CreateDlpJobRequest getDefaultInstanceForType()
Returns
TypeDescription
CreateDlpJobRequest

getInspectJob()

public InspectJobConfig getInspectJob()

An inspection job scans a storage repository for InfoTypes.

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

Returns
TypeDescription
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
TypeDescription
InspectJobConfigOrBuilder

getJobCase()

public CreateDlpJobRequest.JobCase getJobCase()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for jobId.

getLocationId()

public String getLocationId()

Deprecated. This field has no effect.

string location_id = 5;

Returns
TypeDescription
String

The locationId.

getLocationIdBytes()

public ByteString getLocationIdBytes()

Deprecated. This field has no effect.

string location_id = 5;

Returns
TypeDescription
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:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>
  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var>

    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
TypeDescription
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:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>
  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var>

    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
TypeDescription
ByteString

The bytes for parent.

getParserForType()

public Parser<CreateDlpJobRequest> getParserForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
RiskAnalysisJobConfigOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasInspectJob()

public boolean hasInspectJob()

An inspection job scans a storage repository for InfoTypes.

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

Returns
TypeDescription
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
TypeDescription
boolean

Whether the riskJob field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CreateDlpJobRequest.Builder newBuilderForType()
Returns
TypeDescription
CreateDlpJobRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateDlpJobRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CreateDlpJobRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public CreateDlpJobRequest.Builder toBuilder()
Returns
TypeDescription
CreateDlpJobRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException