com.google.storage.v2.WriteObjectSpecOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-storage-v2 Show documentation
Show all versions of proto-google-cloud-storage-v2 Show documentation
PROTO library for proto-google-cloud-storage-v2
/*
* Copyright 2024 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.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/storage/v2/storage.proto
// Protobuf Java Version: 3.25.3
package com.google.storage.v2;
public interface WriteObjectSpecOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.storage.v2.WriteObjectSpec)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Required. Destination object, including its name and its metadata.
*
*
* .google.storage.v2.Object resource = 1 [(.google.api.field_behavior) = REQUIRED];
*
* @return Whether the resource field is set.
*/
boolean hasResource();
/**
*
*
*
* Required. Destination object, including its name and its metadata.
*
*
* .google.storage.v2.Object resource = 1 [(.google.api.field_behavior) = REQUIRED];
*
* @return The resource.
*/
com.google.storage.v2.Object getResource();
/**
*
*
*
* Required. Destination object, including its name and its metadata.
*
*
* .google.storage.v2.Object resource = 1 [(.google.api.field_behavior) = REQUIRED];
*/
com.google.storage.v2.ObjectOrBuilder getResourceOrBuilder();
/**
*
*
*
* Apply a predefined set of access controls to this object.
* Valid values are "authenticatedRead", "bucketOwnerFullControl",
* "bucketOwnerRead", "private", "projectPrivate", or "publicRead".
*
*
* string predefined_acl = 7;
*
* @return The predefinedAcl.
*/
java.lang.String getPredefinedAcl();
/**
*
*
*
* Apply a predefined set of access controls to this object.
* Valid values are "authenticatedRead", "bucketOwnerFullControl",
* "bucketOwnerRead", "private", "projectPrivate", or "publicRead".
*
*
* string predefined_acl = 7;
*
* @return The bytes for predefinedAcl.
*/
com.google.protobuf.ByteString getPredefinedAclBytes();
/**
*
*
*
* Makes the operation conditional on whether the object's current
* generation matches the given value. Setting to 0 makes the operation
* succeed only if there are no live versions of the object.
*
*
* optional int64 if_generation_match = 3;
*
* @return Whether the ifGenerationMatch field is set.
*/
boolean hasIfGenerationMatch();
/**
*
*
*
* Makes the operation conditional on whether the object's current
* generation matches the given value. Setting to 0 makes the operation
* succeed only if there are no live versions of the object.
*
*
* optional int64 if_generation_match = 3;
*
* @return The ifGenerationMatch.
*/
long getIfGenerationMatch();
/**
*
*
*
* Makes the operation conditional on whether the object's live
* generation does not match the given value. If no live object exists, the
* precondition fails. Setting to 0 makes the operation succeed only if
* there is a live version of the object.
*
*
* optional int64 if_generation_not_match = 4;
*
* @return Whether the ifGenerationNotMatch field is set.
*/
boolean hasIfGenerationNotMatch();
/**
*
*
*
* Makes the operation conditional on whether the object's live
* generation does not match the given value. If no live object exists, the
* precondition fails. Setting to 0 makes the operation succeed only if
* there is a live version of the object.
*
*
* optional int64 if_generation_not_match = 4;
*
* @return The ifGenerationNotMatch.
*/
long getIfGenerationNotMatch();
/**
*
*
*
* Makes the operation conditional on whether the object's current
* metageneration matches the given value.
*
*
* optional int64 if_metageneration_match = 5;
*
* @return Whether the ifMetagenerationMatch field is set.
*/
boolean hasIfMetagenerationMatch();
/**
*
*
*
* Makes the operation conditional on whether the object's current
* metageneration matches the given value.
*
*
* optional int64 if_metageneration_match = 5;
*
* @return The ifMetagenerationMatch.
*/
long getIfMetagenerationMatch();
/**
*
*
*
* Makes the operation conditional on whether the object's current
* metageneration does not match the given value.
*
*
* optional int64 if_metageneration_not_match = 6;
*
* @return Whether the ifMetagenerationNotMatch field is set.
*/
boolean hasIfMetagenerationNotMatch();
/**
*
*
*
* Makes the operation conditional on whether the object's current
* metageneration does not match the given value.
*
*
* optional int64 if_metageneration_not_match = 6;
*
* @return The ifMetagenerationNotMatch.
*/
long getIfMetagenerationNotMatch();
/**
*
*
*
* The expected final object size being uploaded.
* If this value is set, closing the stream after writing fewer or more than
* `object_size` bytes will result in an OUT_OF_RANGE error.
*
* This situation is considered a client error, and if such an error occurs
* you must start the upload over from scratch, this time sending the correct
* number of bytes.
*
*
* optional int64 object_size = 8;
*
* @return Whether the objectSize field is set.
*/
boolean hasObjectSize();
/**
*
*
*
* The expected final object size being uploaded.
* If this value is set, closing the stream after writing fewer or more than
* `object_size` bytes will result in an OUT_OF_RANGE error.
*
* This situation is considered a client error, and if such an error occurs
* you must start the upload over from scratch, this time sending the correct
* number of bytes.
*
*
* optional int64 object_size = 8;
*
* @return The objectSize.
*/
long getObjectSize();
}