com.google.api.ads.adwords.lib.utils.BatchJobUploadBodyProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ads-lib Show documentation

Client library for Java for accessing ads APIs including DFP. If you want to use this library, you must also include another Maven artifact to specify which framework you would like to use it with. For example, to use DFP with Axis, you should include the "dfp-axis" artifact.

There is a newer version: 5.7.0

Show newest version

// Copyright 2015 Google Inc. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package com.google.api.ads.adwords.lib.utils;

import com.google.api.client.http.ByteArrayContent;

/**
 * Translates a batch job mutate request into HTTP content for uploading.
 */
public interface BatchJobUploadBodyProvider {
  /**
   * Returns the batch job upload operations as {@link ByteArrayContent}. The return type
   * is {@link ByteArrayContent} to allow utilities to get the content length or log
   * the contents without consuming the stream.
   *
   * @param request the mutate request
   * @param isFirstRequest if this is the first request (for resumable uploads)
   * @param isLastRequest if this is the last request (for resumable uploads)
   * @return the content as a {@link ByteArrayContent}
   */
  ByteArrayContent getHttpContent(BatchJobMutateRequestInterface request, boolean isFirstRequest,
      boolean isLastRequest) throws BatchJobException;
}