com.google.ads.googleads.v17.resources.OfflineUserDataJobOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-ads-stubs-v17 Show documentation
Stubs for GAAPI version google-ads-stubs-v17
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/ads/googleads/v17/resources/offline_user_data_job.proto

// Protobuf Java Version: 3.25.3
package com.google.ads.googleads.v17.resources;

public interface OfflineUserDataJobOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v17.resources.OfflineUserDataJob)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * 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) = { ... }
   * @return The resourceName.
   */
  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) = { ... }
   * @return The bytes for resourceName.
   */
  com.google.protobuf.ByteString
      getResourceNameBytes();

  /**
   *    * Output only. ID of this offline user data job.
   * 
   *
   * optional int64 id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the id field is set.
   */
  boolean hasId();
  /**
   *    * Output only. ID of this offline user data job.
   * 
   *
   * optional int64 id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The id.
   */
  long getId();

  /**
   *    * Immutable. User specified job ID.
   * 
   *
   * optional int64 external_id = 10 [(.google.api.field_behavior) = IMMUTABLE];
   * @return Whether the externalId field is set.
   */
  boolean hasExternalId();
  /**
   *    * Immutable. User specified job ID.
   * 
   *
   * optional int64 external_id = 10 [(.google.api.field_behavior) = IMMUTABLE];
   * @return The externalId.
   */
  long getExternalId();

  /**
   *    * Immutable. Type of the job.
   * 
   *
   * .google.ads.googleads.v17.enums.OfflineUserDataJobTypeEnum.OfflineUserDataJobType type = 4 [(.google.api.field_behavior) = IMMUTABLE];
   * @return The enum numeric value on the wire for type.
   */
  int getTypeValue();
  /**
   *    * Immutable. Type of the job.
   * 
   *
   * .google.ads.googleads.v17.enums.OfflineUserDataJobTypeEnum.OfflineUserDataJobType type = 4 [(.google.api.field_behavior) = IMMUTABLE];
   * @return The type.
   */
  com.google.ads.googleads.v17.enums.OfflineUserDataJobTypeEnum.OfflineUserDataJobType getType();

  /**
   *    * Output only. Status of the job.
   * 
   *
   * .google.ads.googleads.v17.enums.OfflineUserDataJobStatusEnum.OfflineUserDataJobStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for status.
   */
  int getStatusValue();
  /**
   *    * Output only. Status of the job.
   * 
   *
   * .google.ads.googleads.v17.enums.OfflineUserDataJobStatusEnum.OfflineUserDataJobStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The status.
   */
  com.google.ads.googleads.v17.enums.OfflineUserDataJobStatusEnum.OfflineUserDataJobStatus getStatus();

  /**
   *    * Output only. Reason for the processing failure, if status is FAILED.
   * 
   *
   * .google.ads.googleads.v17.enums.OfflineUserDataJobFailureReasonEnum.OfflineUserDataJobFailureReason failure_reason = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for failureReason.
   */
  int getFailureReasonValue();
  /**
   *    * Output only. Reason for the processing failure, if status is FAILED.
   * 
   *
   * .google.ads.googleads.v17.enums.OfflineUserDataJobFailureReasonEnum.OfflineUserDataJobFailureReason failure_reason = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The failureReason.
   */
  com.google.ads.googleads.v17.enums.OfflineUserDataJobFailureReasonEnum.OfflineUserDataJobFailureReason getFailureReason();

  /**
   *    * Output only. Metadata of offline user data job depicting match rate range.
   * 
   *
   * .google.ads.googleads.v17.resources.OfflineUserDataJobMetadata operation_metadata = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the operationMetadata field is set.
   */
  boolean hasOperationMetadata();
  /**
   *    * Output only. Metadata of offline user data job depicting match rate range.
   * 
   *
   * .google.ads.googleads.v17.resources.OfflineUserDataJobMetadata operation_metadata = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The operationMetadata.
   */
  com.google.ads.googleads.v17.resources.OfflineUserDataJobMetadata getOperationMetadata();
  /**
   *    * Output only. Metadata of offline user data job depicting match rate range.
   * 
   *
   * .google.ads.googleads.v17.resources.OfflineUserDataJobMetadata operation_metadata = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  com.google.ads.googleads.v17.resources.OfflineUserDataJobMetadataOrBuilder getOperationMetadataOrBuilder();

  /**
   *    * Immutable. Metadata for data updates to a CRM-based user list.
   * 
   *
   * .google.ads.googleads.v17.common.CustomerMatchUserListMetadata customer_match_user_list_metadata = 7 [(.google.api.field_behavior) = IMMUTABLE];
   * @return Whether the customerMatchUserListMetadata field is set.
   */
  boolean hasCustomerMatchUserListMetadata();
  /**
   *    * Immutable. Metadata for data updates to a CRM-based user list.
   * 
   *
   * .google.ads.googleads.v17.common.CustomerMatchUserListMetadata customer_match_user_list_metadata = 7 [(.google.api.field_behavior) = IMMUTABLE];
   * @return The customerMatchUserListMetadata.
   */
  com.google.ads.googleads.v17.common.CustomerMatchUserListMetadata getCustomerMatchUserListMetadata();
  /**
   *    * Immutable. Metadata for data updates to a CRM-based user list.
   * 
   *
   * .google.ads.googleads.v17.common.CustomerMatchUserListMetadata customer_match_user_list_metadata = 7 [(.google.api.field_behavior) = IMMUTABLE];
   */
  com.google.ads.googleads.v17.common.CustomerMatchUserListMetadataOrBuilder getCustomerMatchUserListMetadataOrBuilder();

  /**
   *    * Immutable. Metadata for store sales data update.
   * 
   *
   * .google.ads.googleads.v17.common.StoreSalesMetadata store_sales_metadata = 8 [(.google.api.field_behavior) = IMMUTABLE];
   * @return Whether the storeSalesMetadata field is set.
   */
  boolean hasStoreSalesMetadata();
  /**
   *    * Immutable. Metadata for store sales data update.
   * 
   *
   * .google.ads.googleads.v17.common.StoreSalesMetadata store_sales_metadata = 8 [(.google.api.field_behavior) = IMMUTABLE];
   * @return The storeSalesMetadata.
   */
  com.google.ads.googleads.v17.common.StoreSalesMetadata getStoreSalesMetadata();
  /**
   *    * Immutable. Metadata for store sales data update.
   * 
   *
   * .google.ads.googleads.v17.common.StoreSalesMetadata store_sales_metadata = 8 [(.google.api.field_behavior) = IMMUTABLE];
   */
  com.google.ads.googleads.v17.common.StoreSalesMetadataOrBuilder getStoreSalesMetadataOrBuilder();

  com.google.ads.googleads.v17.resources.OfflineUserDataJob.MetadataCase getMetadataCase();
}