Struct google_api_proto::google::ads::googleads::v17::resources::BatchJob

pub struct BatchJob {
    pub resource_name: String,
    pub id: Option<i64>,
    pub next_add_sequence_token: Option<String>,
    pub metadata: Option<BatchJobMetadata>,
    pub status: i32,
    pub long_running_operation: Option<String>,
}

A list of mutates being processed asynchronously. The mutates are uploaded by the user. The mutates themselves aren’t readable and the results of the job can only be read using BatchJobService.ListBatchJobResults.

Fields

resource_name: String

Immutable. The resource name of the batch job. Batch job resource names have the form:

customers/{customer_id}/batchJobs/{batch_job_id}

id: Option<i64>

Output only. ID of this batch job.

next_add_sequence_token: Option<String>

Output only. The next sequence token to use when adding operations. Only set when the batch job status is PENDING.

metadata: Option<BatchJobMetadata>

Output only. Contains additional information about this batch job.

status: i32

Output only. Status of this batch job.

long_running_operation: Option<String>

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.

Implementations

impl BatchJob

pub fn status(&self) -> BatchJobStatus

Returns the enum value of status, or the default if the field is set to an invalid enum value.

pub fn set_status(&mut self, value: BatchJobStatus)

Sets status to the provided enum value.

pub fn id(&self) -> i64

Returns the value of id, or the default value if id is unset.

pub fn next_add_sequence_token(&self) -> &str

Returns the value of next_add_sequence_token, or the default value if next_add_sequence_token is unset.

pub fn long_running_operation(&self) -> &str

Returns the value of long_running_operation, or the default value if long_running_operation is unset.

Trait Implementations

impl Clone for BatchJob

fn clone(&self) -> BatchJob

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BatchJob

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for BatchJob

fn default() -> Self

Returns the “default value” for a type.

impl Message for BatchJob

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for BatchJob

fn eq(&self, other: &BatchJob) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BatchJob