Package com.google.ads.googleads.v10.resources

Class OfflineUserDataJob.Builder

  • All Implemented Interfaces:
    OfflineUserDataJobOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable
    Enclosing class:
    OfflineUserDataJob
    public static final class OfflineUserDataJob.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<OfflineUserDataJob.Builder>
implements OfflineUserDataJobOrBuilder
     A job containing offline user data of store visitors, or user list members
 that will be processed asynchronously. The uploaded data isn't readable and
 the processing results of the job can only be read using
 GoogleAdsService.Search/SearchStream.
    Protobuf type google.ads.googleads.v10.resources.OfflineUserDataJob

    • Method Detail

      • 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.Builder<OfflineUserDataJob.Builder>

      • clear

        public OfflineUserDataJob.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<OfflineUserDataJob.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<OfflineUserDataJob.Builder>

      • getDefaultInstanceForType

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

      • build

        public OfflineUserDataJob build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public OfflineUserDataJob buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public OfflineUserDataJob.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<OfflineUserDataJob.Builder>

      • setField

        public OfflineUserDataJob.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                           java.lang.Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<OfflineUserDataJob.Builder>

      • clearField

        public OfflineUserDataJob.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<OfflineUserDataJob.Builder>

      • clearOneof

        public OfflineUserDataJob.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<OfflineUserDataJob.Builder>

      • setRepeatedField

        public OfflineUserDataJob.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                   int index,
                                                   java.lang.Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<OfflineUserDataJob.Builder>

      • addRepeatedField

        public OfflineUserDataJob.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                   java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<OfflineUserDataJob.Builder>

      • mergeFrom

        public OfflineUserDataJob.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<OfflineUserDataJob.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<OfflineUserDataJob.Builder>

      • mergeFrom

        public OfflineUserDataJob.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<OfflineUserDataJob.Builder>
        Throws:
        java.io.IOException

      • getResourceName

        public java.lang.String getResourceName()
         Immutable. The resource name of the offline user data job.
 Offline user data job resource names have the form:
 `customers/{customer_id}/offlineUserDataJobs/{offline_user_data_job_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceName in interface OfflineUserDataJobOrBuilder
        Returns:
        The resourceName.

      • getResourceNameBytes

        public com.google.protobuf.ByteString getResourceNameBytes()
         Immutable. The resource name of the offline user data job.
 Offline user data job resource names have the form:
 `customers/{customer_id}/offlineUserDataJobs/{offline_user_data_job_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceNameBytes in interface OfflineUserDataJobOrBuilder
        Returns:
        The bytes for resourceName.

      • setResourceName

        public OfflineUserDataJob.Builder setResourceName​(java.lang.String value)
         Immutable. The resource name of the offline user data job.
 Offline user data job resource names have the form:
 `customers/{customer_id}/offlineUserDataJobs/{offline_user_data_job_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The resourceName to set.
        Returns:
        This builder for chaining.

      • clearResourceName

        public OfflineUserDataJob.Builder clearResourceName()
         Immutable. The resource name of the offline user data job.
 Offline user data job resource names have the form:
 `customers/{customer_id}/offlineUserDataJobs/{offline_user_data_job_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • setResourceNameBytes

        public OfflineUserDataJob.Builder setResourceNameBytes​(com.google.protobuf.ByteString value)
         Immutable. The resource name of the offline user data job.
 Offline user data job resource names have the form:
 `customers/{customer_id}/offlineUserDataJobs/{offline_user_data_job_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for resourceName to set.
        Returns:
        This builder for chaining.

      • hasId

        public boolean hasId()
         Output only. ID of this offline user data job.
        optional int64 id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasId in interface OfflineUserDataJobOrBuilder
        Returns:
        Whether the id field is set.

      • getId

        public long getId()
         Output only. ID of this offline user data job.
        optional int64 id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getId in interface OfflineUserDataJobOrBuilder
        Returns:
        The id.

      • setId

        public OfflineUserDataJob.Builder setId​(long value)
         Output only. ID of this offline user data job.
        optional int64 id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The id to set.
        Returns:
        This builder for chaining.

      • clearId

        public OfflineUserDataJob.Builder clearId()
         Output only. ID of this offline user data job.
        optional int64 id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.

      • hasExternalId

        public boolean hasExternalId()
         Immutable. User specified job ID.
        optional int64 external_id = 10 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        hasExternalId in interface OfflineUserDataJobOrBuilder
        Returns:
        Whether the externalId field is set.

      • getExternalId

        public long getExternalId()
         Immutable. User specified job ID.
        optional int64 external_id = 10 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getExternalId in interface OfflineUserDataJobOrBuilder
        Returns:
        The externalId.

      • setExternalId

        public OfflineUserDataJob.Builder setExternalId​(long value)
         Immutable. User specified job ID.
        optional int64 external_id = 10 [(.google.api.field_behavior) = IMMUTABLE];
        Parameters:
        value - The externalId to set.
        Returns:
        This builder for chaining.

      • clearExternalId

        public OfflineUserDataJob.Builder clearExternalId()
         Immutable. User specified job ID.
        optional int64 external_id = 10 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        This builder for chaining.

      • getTypeValue

        public int getTypeValue()
         Immutable. Type of the job.
        .google.ads.googleads.v10.enums.OfflineUserDataJobTypeEnum.OfflineUserDataJobType type = 4 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getTypeValue in interface OfflineUserDataJobOrBuilder
        Returns:
        The enum numeric value on the wire for type.

      • setTypeValue

        public OfflineUserDataJob.Builder setTypeValue​(int value)
         Immutable. Type of the job.
        .google.ads.googleads.v10.enums.OfflineUserDataJobTypeEnum.OfflineUserDataJobType type = 4 [(.google.api.field_behavior) = IMMUTABLE];
        Parameters:
        value - The enum numeric value on the wire for type to set.
        Returns:
        This builder for chaining.

      • clearType

        public OfflineUserDataJob.Builder clearType()
         Immutable. Type of the job.
        .google.ads.googleads.v10.enums.OfflineUserDataJobTypeEnum.OfflineUserDataJobType type = 4 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        This builder for chaining.

      • getStatusValue

        public int getStatusValue()
         Output only. Status of the job.
        .google.ads.googleads.v10.enums.OfflineUserDataJobStatusEnum.OfflineUserDataJobStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStatusValue in interface OfflineUserDataJobOrBuilder
        Returns:
        The enum numeric value on the wire for status.

      • setStatusValue

        public OfflineUserDataJob.Builder setStatusValue​(int value)
         Output only. Status of the job.
        .google.ads.googleads.v10.enums.OfflineUserDataJobStatusEnum.OfflineUserDataJobStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The enum numeric value on the wire for status to set.
        Returns:
        This builder for chaining.

      • clearStatus

        public OfflineUserDataJob.Builder clearStatus()
         Output only. Status of the job.
        .google.ads.googleads.v10.enums.OfflineUserDataJobStatusEnum.OfflineUserDataJobStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.

      • getFailureReasonValue

        public int getFailureReasonValue()
         Output only. Reason for the processing failure, if status is FAILED.
        .google.ads.googleads.v10.enums.OfflineUserDataJobFailureReasonEnum.OfflineUserDataJobFailureReason failure_reason = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getFailureReasonValue in interface OfflineUserDataJobOrBuilder
        Returns:
        The enum numeric value on the wire for failureReason.

      • setFailureReasonValue

        public OfflineUserDataJob.Builder setFailureReasonValue​(int value)
         Output only. Reason for the processing failure, if status is FAILED.
        .google.ads.googleads.v10.enums.OfflineUserDataJobFailureReasonEnum.OfflineUserDataJobFailureReason failure_reason = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The enum numeric value on the wire for failureReason to set.
        Returns:
        This builder for chaining.

      • setFailureReason

        public OfflineUserDataJob.Builder setFailureReason​(OfflineUserDataJobFailureReasonEnum.OfflineUserDataJobFailureReason value)
         Output only. Reason for the processing failure, if status is FAILED.
        .google.ads.googleads.v10.enums.OfflineUserDataJobFailureReasonEnum.OfflineUserDataJobFailureReason failure_reason = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The failureReason to set.
        Returns:
        This builder for chaining.

      • clearFailureReason

        public OfflineUserDataJob.Builder clearFailureReason()
         Output only. Reason for the processing failure, if status is FAILED.
        .google.ads.googleads.v10.enums.OfflineUserDataJobFailureReasonEnum.OfflineUserDataJobFailureReason failure_reason = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.

      • hasOperationMetadata

        public boolean hasOperationMetadata()
         Output only. Metadata of offline user data job depicting match rate range.
        .google.ads.googleads.v10.resources.OfflineUserDataJobMetadata operation_metadata = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasOperationMetadata in interface OfflineUserDataJobOrBuilder
        Returns:
        Whether the operationMetadata field is set.

      • getOperationMetadata

        public OfflineUserDataJobMetadata getOperationMetadata()
         Output only. Metadata of offline user data job depicting match rate range.
        .google.ads.googleads.v10.resources.OfflineUserDataJobMetadata operation_metadata = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getOperationMetadata in interface OfflineUserDataJobOrBuilder
        Returns:
        The operationMetadata.

      • setOperationMetadata

        public OfflineUserDataJob.Builder setOperationMetadata​(OfflineUserDataJobMetadata value)
         Output only. Metadata of offline user data job depicting match rate range.
        .google.ads.googleads.v10.resources.OfflineUserDataJobMetadata operation_metadata = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • setOperationMetadata

        public OfflineUserDataJob.Builder setOperationMetadata​(OfflineUserDataJobMetadata.Builder builderForValue)
         Output only. Metadata of offline user data job depicting match rate range.
        .google.ads.googleads.v10.resources.OfflineUserDataJobMetadata operation_metadata = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • mergeOperationMetadata

        public OfflineUserDataJob.Builder mergeOperationMetadata​(OfflineUserDataJobMetadata value)
         Output only. Metadata of offline user data job depicting match rate range.
        .google.ads.googleads.v10.resources.OfflineUserDataJobMetadata operation_metadata = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • clearOperationMetadata

        public OfflineUserDataJob.Builder clearOperationMetadata()
         Output only. Metadata of offline user data job depicting match rate range.
        .google.ads.googleads.v10.resources.OfflineUserDataJobMetadata operation_metadata = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getOperationMetadataBuilder

        public OfflineUserDataJobMetadata.Builder getOperationMetadataBuilder()
         Output only. Metadata of offline user data job depicting match rate range.
        .google.ads.googleads.v10.resources.OfflineUserDataJobMetadata operation_metadata = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasCustomerMatchUserListMetadata

        public boolean hasCustomerMatchUserListMetadata()
         Immutable. Metadata for data updates to a CRM-based user list.
        .google.ads.googleads.v10.common.CustomerMatchUserListMetadata customer_match_user_list_metadata = 7 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        hasCustomerMatchUserListMetadata in interface OfflineUserDataJobOrBuilder
        Returns:
        Whether the customerMatchUserListMetadata field is set.

      • getCustomerMatchUserListMetadata

        public CustomerMatchUserListMetadata getCustomerMatchUserListMetadata()
         Immutable. Metadata for data updates to a CRM-based user list.
        .google.ads.googleads.v10.common.CustomerMatchUserListMetadata customer_match_user_list_metadata = 7 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getCustomerMatchUserListMetadata in interface OfflineUserDataJobOrBuilder
        Returns:
        The customerMatchUserListMetadata.

      • setCustomerMatchUserListMetadata

        public OfflineUserDataJob.Builder setCustomerMatchUserListMetadata​(CustomerMatchUserListMetadata value)
         Immutable. Metadata for data updates to a CRM-based user list.
        .google.ads.googleads.v10.common.CustomerMatchUserListMetadata customer_match_user_list_metadata = 7 [(.google.api.field_behavior) = IMMUTABLE];

      • setCustomerMatchUserListMetadata

        public OfflineUserDataJob.Builder setCustomerMatchUserListMetadata​(CustomerMatchUserListMetadata.Builder builderForValue)
         Immutable. Metadata for data updates to a CRM-based user list.
        .google.ads.googleads.v10.common.CustomerMatchUserListMetadata customer_match_user_list_metadata = 7 [(.google.api.field_behavior) = IMMUTABLE];

      • mergeCustomerMatchUserListMetadata

        public OfflineUserDataJob.Builder mergeCustomerMatchUserListMetadata​(CustomerMatchUserListMetadata value)
         Immutable. Metadata for data updates to a CRM-based user list.
        .google.ads.googleads.v10.common.CustomerMatchUserListMetadata customer_match_user_list_metadata = 7 [(.google.api.field_behavior) = IMMUTABLE];

      • clearCustomerMatchUserListMetadata

        public OfflineUserDataJob.Builder clearCustomerMatchUserListMetadata()
         Immutable. Metadata for data updates to a CRM-based user list.
        .google.ads.googleads.v10.common.CustomerMatchUserListMetadata customer_match_user_list_metadata = 7 [(.google.api.field_behavior) = IMMUTABLE];

      • getCustomerMatchUserListMetadataBuilder

        public CustomerMatchUserListMetadata.Builder getCustomerMatchUserListMetadataBuilder()
         Immutable. Metadata for data updates to a CRM-based user list.
        .google.ads.googleads.v10.common.CustomerMatchUserListMetadata customer_match_user_list_metadata = 7 [(.google.api.field_behavior) = IMMUTABLE];

      • hasStoreSalesMetadata

        public boolean hasStoreSalesMetadata()
         Immutable. Metadata for store sales data update.
        .google.ads.googleads.v10.common.StoreSalesMetadata store_sales_metadata = 8 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        hasStoreSalesMetadata in interface OfflineUserDataJobOrBuilder
        Returns:
        Whether the storeSalesMetadata field is set.

      • getStoreSalesMetadata

        public StoreSalesMetadata getStoreSalesMetadata()
         Immutable. Metadata for store sales data update.
        .google.ads.googleads.v10.common.StoreSalesMetadata store_sales_metadata = 8 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getStoreSalesMetadata in interface OfflineUserDataJobOrBuilder
        Returns:
        The storeSalesMetadata.

      • setStoreSalesMetadata

        public OfflineUserDataJob.Builder setStoreSalesMetadata​(StoreSalesMetadata value)
         Immutable. Metadata for store sales data update.
        .google.ads.googleads.v10.common.StoreSalesMetadata store_sales_metadata = 8 [(.google.api.field_behavior) = IMMUTABLE];

      • setStoreSalesMetadata

        public OfflineUserDataJob.Builder setStoreSalesMetadata​(StoreSalesMetadata.Builder builderForValue)
         Immutable. Metadata for store sales data update.
        .google.ads.googleads.v10.common.StoreSalesMetadata store_sales_metadata = 8 [(.google.api.field_behavior) = IMMUTABLE];

      • mergeStoreSalesMetadata

        public OfflineUserDataJob.Builder mergeStoreSalesMetadata​(StoreSalesMetadata value)
         Immutable. Metadata for store sales data update.
        .google.ads.googleads.v10.common.StoreSalesMetadata store_sales_metadata = 8 [(.google.api.field_behavior) = IMMUTABLE];

      • clearStoreSalesMetadata

        public OfflineUserDataJob.Builder clearStoreSalesMetadata()
         Immutable. Metadata for store sales data update.
        .google.ads.googleads.v10.common.StoreSalesMetadata store_sales_metadata = 8 [(.google.api.field_behavior) = IMMUTABLE];

      • getStoreSalesMetadataBuilder

        public StoreSalesMetadata.Builder getStoreSalesMetadataBuilder()
         Immutable. Metadata for store sales data update.
        .google.ads.googleads.v10.common.StoreSalesMetadata store_sales_metadata = 8 [(.google.api.field_behavior) = IMMUTABLE];

      • setUnknownFields

        public final OfflineUserDataJob.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<OfflineUserDataJob.Builder>

      • mergeUnknownFields

        public final OfflineUserDataJob.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<OfflineUserDataJob.Builder>