upload_options.h

Go to the documentation of this file.

// Copyright 2018 Google LLC
//
// 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
//
//     https://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.
 
#ifndef GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_STORAGE_UPLOAD_OPTIONS_H
#define GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_STORAGE_UPLOAD_OPTIONS_H
 
#include "google/cloud/storage/internal/complex_option.h"
#include "google/cloud/storage/version.h"
#include "google/cloud/storage/well_known_headers.h"
#include <string>
 
namespace google {
namespace cloud {
namespace storage {
GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
/**
 * Request a resumable upload, restoring a previous session if necessary.
 *
 * When this option is used the client library prefers using resumable uploads.
 *
 * If the value passed to this option is the empty string, then the library will
 * create a new resumable session. Otherwise the value should be the id of a
 * previous upload session, the client library will restore that session in
 * this case.
 */
struct UseResumableUploadSession
    : public internal::ComplexOption<UseResumableUploadSession, std::string> {
  using ComplexOption<UseResumableUploadSession, std::string>::ComplexOption;
  // GCC <= 7.0 does not use the inherited default constructor, redeclare it
  // explicitly
  UseResumableUploadSession() = default;
 
  static char const* name() { return "resumable-upload"; }
};
 
/// Create a UseResumableUploadSession option that restores previous sessions.
inline UseResumableUploadSession RestoreResumableUploadSession(
    std::string session_id) {
  return UseResumableUploadSession(std::move(session_id));
}
 
/// Create a UseResumableUploadSession option that requests new sessions.
inline UseResumableUploadSession NewResumableUploadSession() {
  return UseResumableUploadSession("");
}
 
/**
 * Provide an expected final length of an uploaded object.
 *
 * Resumable uploads allow or an additional integrity check - make GCS check
 * if the uploaded content matches the declared length. If it doesn't the upload
 * will fail.
 */
struct UploadContentLength
    : public internal::WellKnownHeader<UploadContentLength, std::uintmax_t> {
  using internal::WellKnownHeader<UploadContentLength,
                                  std::uintmax_t>::WellKnownHeader;
  static char const* header_name() { return "X-Upload-Content-Length"; }
};
 
/**
 * Upload the local file to GCS server starting at the given offset.
 */
struct UploadFromOffset
    : public internal::ComplexOption<UploadFromOffset, std::uint64_t> {
  using ComplexOption::ComplexOption;
  // GCC <= 7.0 does not use the inherited default constructor, redeclare it
  // explicitly
  UploadFromOffset() = default;
  static char const* name() { return "upload-offset"; }
};
 
/**
 * The maximum length of the local file to upload to GCS server.
 */
struct UploadLimit
    : public internal::ComplexOption<UploadLimit, std::uint64_t> {
  using ComplexOption::ComplexOption;
  // GCC <= 7.0 does not use the inherited default constructor, redeclare it
  // explicitly
  UploadLimit() = default;
  static char const* name() { return "upload-limit"; }
};
 
/**
 * Set the buffer size for a stream created in `Client::WriteObject()`.
 *
 * Some applications may need to tune the upload buffer for some specific
 * uploads. This option can be passed to `Client::WriteObject()` to override the
 * default setting in the `storage::Client`.
 */
struct UploadBufferSize
    : public internal::ComplexOption<UploadBufferSize, std::size_t> {
  using ComplexOption<UploadBufferSize, std::size_t>::ComplexOption;
  // GCC <= 7.0 does not use the inherited default constructor, redeclare it
  // explicitly
  UploadBufferSize() = default;
  static char const* name() { return "upload-buffer-size"; }
};
 
GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END
}  // namespace storage
}  // namespace cloud
}  // namespace google
 
#endif  // GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_STORAGE_UPLOAD_OPTIONS_H