Interface BatchJobOrBuilder
-
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
BatchJob
,BatchJob.Builder
public interface BatchJobOrBuilder extends com.google.protobuf.MessageOrBuilder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description long
getId()
Output only.java.lang.String
getLongRunningOperation()
Output only.com.google.protobuf.ByteString
getLongRunningOperationBytes()
Output only.BatchJob.BatchJobMetadata
getMetadata()
Output only.BatchJob.BatchJobMetadataOrBuilder
getMetadataOrBuilder()
Output only.java.lang.String
getNextAddSequenceToken()
Output only.com.google.protobuf.ByteString
getNextAddSequenceTokenBytes()
Output only.java.lang.String
getResourceName()
Immutable.com.google.protobuf.ByteString
getResourceNameBytes()
Immutable.BatchJobStatusEnum.BatchJobStatus
getStatus()
Output only.int
getStatusValue()
Output only.boolean
hasId()
Output only.boolean
hasLongRunningOperation()
Output only.boolean
hasMetadata()
Output only.boolean
hasNextAddSequenceToken()
Output only.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
getResourceName
java.lang.String getResourceName()
Immutable. The resource name of the batch job. Batch job resource names have the form: `customers/{customer_id}/batchJobs/{batch_job_id}`
string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
- Returns:
- The resourceName.
-
getResourceNameBytes
com.google.protobuf.ByteString getResourceNameBytes()
Immutable. The resource name of the batch job. Batch job resource names have the form: `customers/{customer_id}/batchJobs/{batch_job_id}`
string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
- Returns:
- The bytes for resourceName.
-
hasId
boolean hasId()
Output only. ID of this batch job.
optional int64 id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Returns:
- Whether the id field is set.
-
getId
long getId()
Output only. ID of this batch job.
optional int64 id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Returns:
- The id.
-
hasNextAddSequenceToken
boolean hasNextAddSequenceToken()
Output only. The next sequence token to use when adding operations. Only set when the batch job status is PENDING.
optional string next_add_sequence_token = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Returns:
- Whether the nextAddSequenceToken field is set.
-
getNextAddSequenceToken
java.lang.String getNextAddSequenceToken()
Output only. The next sequence token to use when adding operations. Only set when the batch job status is PENDING.
optional string next_add_sequence_token = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Returns:
- The nextAddSequenceToken.
-
getNextAddSequenceTokenBytes
com.google.protobuf.ByteString getNextAddSequenceTokenBytes()
Output only. The next sequence token to use when adding operations. Only set when the batch job status is PENDING.
optional string next_add_sequence_token = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Returns:
- The bytes for nextAddSequenceToken.
-
hasMetadata
boolean hasMetadata()
Output only. Contains additional information about this batch job.
.google.ads.googleads.v14.resources.BatchJob.BatchJobMetadata metadata = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Returns:
- Whether the metadata field is set.
-
getMetadata
BatchJob.BatchJobMetadata getMetadata()
Output only. Contains additional information about this batch job.
.google.ads.googleads.v14.resources.BatchJob.BatchJobMetadata metadata = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Returns:
- The metadata.
-
getMetadataOrBuilder
BatchJob.BatchJobMetadataOrBuilder getMetadataOrBuilder()
Output only. Contains additional information about this batch job.
.google.ads.googleads.v14.resources.BatchJob.BatchJobMetadata metadata = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
-
getStatusValue
int getStatusValue()
Output only. Status of this batch job.
.google.ads.googleads.v14.enums.BatchJobStatusEnum.BatchJobStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Returns:
- The enum numeric value on the wire for status.
-
getStatus
BatchJobStatusEnum.BatchJobStatus getStatus()
Output only. Status of this batch job.
.google.ads.googleads.v14.enums.BatchJobStatusEnum.BatchJobStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Returns:
- The status.
-
hasLongRunningOperation
boolean hasLongRunningOperation()
Output only. The resource name of the long-running operation that can be used to poll for completion. Only set when the batch job status is RUNNING or DONE.
optional string long_running_operation = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Returns:
- Whether the longRunningOperation field is set.
-
getLongRunningOperation
java.lang.String getLongRunningOperation()
Output only. The resource name of the long-running operation that can be used to poll for completion. Only set when the batch job status is RUNNING or DONE.
optional string long_running_operation = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Returns:
- The longRunningOperation.
-
getLongRunningOperationBytes
com.google.protobuf.ByteString getLongRunningOperationBytes()
Output only. The resource name of the long-running operation that can be used to poll for completion. Only set when the batch job status is RUNNING or DONE.
optional string long_running_operation = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Returns:
- The bytes for longRunningOperation.
-
-