Class BatchJob.BatchJobMetadata

  • All Implemented Interfaces:
    BatchJob.BatchJobMetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    Enclosing class:
    BatchJob

    public static final class BatchJob.BatchJobMetadata
    extends com.google.protobuf.GeneratedMessageV3
    implements BatchJob.BatchJobMetadataOrBuilder
     Additional information about the batch job. This message is also used as
     metadata returned in batch job Long Running Operations.
     
    Protobuf type google.ads.googleads.v10.resources.BatchJob.BatchJobMetadata
    See Also:
    Serialized Form
    • Field Detail

      • CREATION_DATE_TIME_FIELD_NUMBER

        public static final int CREATION_DATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values
      • START_DATE_TIME_FIELD_NUMBER

        public static final int START_DATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values
      • COMPLETION_DATE_TIME_FIELD_NUMBER

        public static final int COMPLETION_DATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values
      • ESTIMATED_COMPLETION_RATIO_FIELD_NUMBER

        public static final int ESTIMATED_COMPLETION_RATIO_FIELD_NUMBER
        See Also:
        Constant Field Values
      • OPERATION_COUNT_FIELD_NUMBER

        public static final int OPERATION_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values
      • EXECUTED_OPERATION_COUNT_FIELD_NUMBER

        public static final int EXECUTED_OPERATION_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • hasCreationDateTime

        public boolean hasCreationDateTime()
         Output only. The time when this batch job was created.
         Formatted as yyyy-mm-dd hh:mm:ss. Example: "2018-03-05 09:15:00"
         
        optional string creation_date_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreationDateTime in interface BatchJob.BatchJobMetadataOrBuilder
        Returns:
        Whether the creationDateTime field is set.
      • getCreationDateTime

        public java.lang.String getCreationDateTime()
         Output only. The time when this batch job was created.
         Formatted as yyyy-mm-dd hh:mm:ss. Example: "2018-03-05 09:15:00"
         
        optional string creation_date_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreationDateTime in interface BatchJob.BatchJobMetadataOrBuilder
        Returns:
        The creationDateTime.
      • getCreationDateTimeBytes

        public com.google.protobuf.ByteString getCreationDateTimeBytes()
         Output only. The time when this batch job was created.
         Formatted as yyyy-mm-dd hh:mm:ss. Example: "2018-03-05 09:15:00"
         
        optional string creation_date_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreationDateTimeBytes in interface BatchJob.BatchJobMetadataOrBuilder
        Returns:
        The bytes for creationDateTime.
      • hasStartDateTime

        public boolean hasStartDateTime()
         Output only. The time when this batch job started running.
         Formatted as yyyy-mm-dd hh:mm:ss. Example: "2018-03-05 09:15:30"
         
        optional string start_date_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasStartDateTime in interface BatchJob.BatchJobMetadataOrBuilder
        Returns:
        Whether the startDateTime field is set.
      • getStartDateTime

        public java.lang.String getStartDateTime()
         Output only. The time when this batch job started running.
         Formatted as yyyy-mm-dd hh:mm:ss. Example: "2018-03-05 09:15:30"
         
        optional string start_date_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStartDateTime in interface BatchJob.BatchJobMetadataOrBuilder
        Returns:
        The startDateTime.
      • getStartDateTimeBytes

        public com.google.protobuf.ByteString getStartDateTimeBytes()
         Output only. The time when this batch job started running.
         Formatted as yyyy-mm-dd hh:mm:ss. Example: "2018-03-05 09:15:30"
         
        optional string start_date_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStartDateTimeBytes in interface BatchJob.BatchJobMetadataOrBuilder
        Returns:
        The bytes for startDateTime.
      • hasCompletionDateTime

        public boolean hasCompletionDateTime()
         Output only. The time when this batch job was completed.
         Formatted as yyyy-MM-dd HH:mm:ss. Example: "2018-03-05 09:16:00"
         
        optional string completion_date_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCompletionDateTime in interface BatchJob.BatchJobMetadataOrBuilder
        Returns:
        Whether the completionDateTime field is set.
      • getCompletionDateTime

        public java.lang.String getCompletionDateTime()
         Output only. The time when this batch job was completed.
         Formatted as yyyy-MM-dd HH:mm:ss. Example: "2018-03-05 09:16:00"
         
        optional string completion_date_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCompletionDateTime in interface BatchJob.BatchJobMetadataOrBuilder
        Returns:
        The completionDateTime.
      • getCompletionDateTimeBytes

        public com.google.protobuf.ByteString getCompletionDateTimeBytes()
         Output only. The time when this batch job was completed.
         Formatted as yyyy-MM-dd HH:mm:ss. Example: "2018-03-05 09:16:00"
         
        optional string completion_date_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCompletionDateTimeBytes in interface BatchJob.BatchJobMetadataOrBuilder
        Returns:
        The bytes for completionDateTime.
      • hasEstimatedCompletionRatio

        public boolean hasEstimatedCompletionRatio()
         Output only. The fraction (between 0.0 and 1.0) of mutates that have been processed.
         This is empty if the job hasn't started running yet.
         
        optional double estimated_completion_ratio = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasEstimatedCompletionRatio in interface BatchJob.BatchJobMetadataOrBuilder
        Returns:
        Whether the estimatedCompletionRatio field is set.
      • getEstimatedCompletionRatio

        public double getEstimatedCompletionRatio()
         Output only. The fraction (between 0.0 and 1.0) of mutates that have been processed.
         This is empty if the job hasn't started running yet.
         
        optional double estimated_completion_ratio = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEstimatedCompletionRatio in interface BatchJob.BatchJobMetadataOrBuilder
        Returns:
        The estimatedCompletionRatio.
      • hasOperationCount

        public boolean hasOperationCount()
         Output only. The number of mutate operations in the batch job.
         
        optional int64 operation_count = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasOperationCount in interface BatchJob.BatchJobMetadataOrBuilder
        Returns:
        Whether the operationCount field is set.
      • getOperationCount

        public long getOperationCount()
         Output only. The number of mutate operations in the batch job.
         
        optional int64 operation_count = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getOperationCount in interface BatchJob.BatchJobMetadataOrBuilder
        Returns:
        The operationCount.
      • hasExecutedOperationCount

        public boolean hasExecutedOperationCount()
         Output only. The number of mutate operations executed by the batch job.
         Present only if the job has started running.
         
        optional int64 executed_operation_count = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasExecutedOperationCount in interface BatchJob.BatchJobMetadataOrBuilder
        Returns:
        Whether the executedOperationCount field is set.
      • getExecutedOperationCount

        public long getExecutedOperationCount()
         Output only. The number of mutate operations executed by the batch job.
         Present only if the job has started running.
         
        optional int64 executed_operation_count = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getExecutedOperationCount in interface BatchJob.BatchJobMetadataOrBuilder
        Returns:
        The executedOperationCount.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static BatchJob.BatchJobMetadata parseFrom​(java.nio.ByteBuffer data)
                                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static BatchJob.BatchJobMetadata parseFrom​(java.nio.ByteBuffer data,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static BatchJob.BatchJobMetadata parseFrom​(com.google.protobuf.ByteString data)
                                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static BatchJob.BatchJobMetadata parseFrom​(com.google.protobuf.ByteString data,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static BatchJob.BatchJobMetadata parseFrom​(byte[] data)
                                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static BatchJob.BatchJobMetadata parseFrom​(byte[] data,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static BatchJob.BatchJobMetadata parseFrom​(java.io.InputStream input)
                                                   throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static BatchJob.BatchJobMetadata parseFrom​(java.io.InputStream input,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static BatchJob.BatchJobMetadata parseDelimitedFrom​(java.io.InputStream input)
                                                            throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static BatchJob.BatchJobMetadata parseDelimitedFrom​(java.io.InputStream input,
                                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                            throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static BatchJob.BatchJobMetadata parseFrom​(com.google.protobuf.CodedInputStream input)
                                                   throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static BatchJob.BatchJobMetadata parseFrom​(com.google.protobuf.CodedInputStream input,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws java.io.IOException
        Throws:
        java.io.IOException
      • newBuilderForType

        public BatchJob.BatchJobMetadata.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public BatchJob.BatchJobMetadata.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected BatchJob.BatchJobMetadata.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<BatchJob.BatchJobMetadata> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public BatchJob.BatchJobMetadata getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder