/*
* 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/pubsub/v1/pubsub.proto
// Protobuf Java Version: 3.25.5
package com.google.pubsub.v1;
public interface CloudStorageConfigOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.pubsub.v1.CloudStorageConfig)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Required. User-provided name for the Cloud Storage bucket.
* The bucket must be created by the user. The bucket name must be without
* any prefix like "gs://". See the [bucket naming
* requirements] (https://cloud.google.com/storage/docs/buckets#naming).
*
*
* string bucket = 1 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bucket.
*/
java.lang.String getBucket();
/**
*
*
*
* Required. User-provided name for the Cloud Storage bucket.
* The bucket must be created by the user. The bucket name must be without
* any prefix like "gs://". See the [bucket naming
* requirements] (https://cloud.google.com/storage/docs/buckets#naming).
*
*
* string bucket = 1 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for bucket.
*/
com.google.protobuf.ByteString getBucketBytes();
/**
*
*
*
* Optional. User-provided prefix for Cloud Storage filename. See the [object
* naming requirements](https://cloud.google.com/storage/docs/objects#naming).
*
*
* string filename_prefix = 2 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The filenamePrefix.
*/
java.lang.String getFilenamePrefix();
/**
*
*
*
* Optional. User-provided prefix for Cloud Storage filename. See the [object
* naming requirements](https://cloud.google.com/storage/docs/objects#naming).
*
*
* string filename_prefix = 2 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for filenamePrefix.
*/
com.google.protobuf.ByteString getFilenamePrefixBytes();
/**
*
*
*
* Optional. User-provided suffix for Cloud Storage filename. See the [object
* naming requirements](https://cloud.google.com/storage/docs/objects#naming).
* Must not end in "/".
*
*
* string filename_suffix = 3 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The filenameSuffix.
*/
java.lang.String getFilenameSuffix();
/**
*
*
*
* Optional. User-provided suffix for Cloud Storage filename. See the [object
* naming requirements](https://cloud.google.com/storage/docs/objects#naming).
* Must not end in "/".
*
*
* string filename_suffix = 3 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for filenameSuffix.
*/
com.google.protobuf.ByteString getFilenameSuffixBytes();
/**
*
*
*
* Optional. User-provided format string specifying how to represent datetimes
* in Cloud Storage filenames. See the [datetime format
* guidance](https://cloud.google.com/pubsub/docs/create-cloudstorage-subscription#file_names).
*
*
* string filename_datetime_format = 10 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The filenameDatetimeFormat.
*/
java.lang.String getFilenameDatetimeFormat();
/**
*
*
*
* Optional. User-provided format string specifying how to represent datetimes
* in Cloud Storage filenames. See the [datetime format
* guidance](https://cloud.google.com/pubsub/docs/create-cloudstorage-subscription#file_names).
*
*
* string filename_datetime_format = 10 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for filenameDatetimeFormat.
*/
com.google.protobuf.ByteString getFilenameDatetimeFormatBytes();
/**
*
*
*
* Optional. If set, message data will be written to Cloud Storage in text
* format.
*
*
*
* .google.pubsub.v1.CloudStorageConfig.TextConfig text_config = 4 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the textConfig field is set.
*/
boolean hasTextConfig();
/**
*
*
*
* Optional. If set, message data will be written to Cloud Storage in text
* format.
*
*
*
* .google.pubsub.v1.CloudStorageConfig.TextConfig text_config = 4 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The textConfig.
*/
com.google.pubsub.v1.CloudStorageConfig.TextConfig getTextConfig();
/**
*
*
*
* Optional. If set, message data will be written to Cloud Storage in text
* format.
*
*
*
* .google.pubsub.v1.CloudStorageConfig.TextConfig text_config = 4 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.pubsub.v1.CloudStorageConfig.TextConfigOrBuilder getTextConfigOrBuilder();
/**
*
*
*
* Optional. If set, message data will be written to Cloud Storage in Avro
* format.
*
*
*
* .google.pubsub.v1.CloudStorageConfig.AvroConfig avro_config = 5 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the avroConfig field is set.
*/
boolean hasAvroConfig();
/**
*
*
*
* Optional. If set, message data will be written to Cloud Storage in Avro
* format.
*
*
*
* .google.pubsub.v1.CloudStorageConfig.AvroConfig avro_config = 5 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The avroConfig.
*/
com.google.pubsub.v1.CloudStorageConfig.AvroConfig getAvroConfig();
/**
*
*
*
* Optional. If set, message data will be written to Cloud Storage in Avro
* format.
*
*
*
* .google.pubsub.v1.CloudStorageConfig.AvroConfig avro_config = 5 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.pubsub.v1.CloudStorageConfig.AvroConfigOrBuilder getAvroConfigOrBuilder();
/**
*
*
*
* Optional. The maximum duration that can elapse before a new Cloud Storage
* file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not
* exceed the subscription's acknowledgement deadline.
*
*
* .google.protobuf.Duration max_duration = 6 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the maxDuration field is set.
*/
boolean hasMaxDuration();
/**
*
*
*
* Optional. The maximum duration that can elapse before a new Cloud Storage
* file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not
* exceed the subscription's acknowledgement deadline.
*
*
* .google.protobuf.Duration max_duration = 6 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The maxDuration.
*/
com.google.protobuf.Duration getMaxDuration();
/**
*
*
*
* Optional. The maximum duration that can elapse before a new Cloud Storage
* file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not
* exceed the subscription's acknowledgement deadline.
*
*
* .google.protobuf.Duration max_duration = 6 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.protobuf.DurationOrBuilder getMaxDurationOrBuilder();
/**
*
*
*
* Optional. The maximum bytes that can be written to a Cloud Storage file
* before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may
* be exceeded in cases where messages are larger than the limit.
*
*
* int64 max_bytes = 7 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The maxBytes.
*/
long getMaxBytes();
/**
*
*
*
* Optional. The maximum number of messages that can be written to a Cloud
* Storage file before a new file is created. Min 1000 messages.
*
*
* int64 max_messages = 8 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The maxMessages.
*/
long getMaxMessages();
/**
*
*
*
* Output only. An output-only field that indicates whether or not the
* subscription can receive messages.
*
*
*
* .google.pubsub.v1.CloudStorageConfig.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The enum numeric value on the wire for state.
*/
int getStateValue();
/**
*
*
*
* Output only. An output-only field that indicates whether or not the
* subscription can receive messages.
*
*
*
* .google.pubsub.v1.CloudStorageConfig.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The state.
*/
com.google.pubsub.v1.CloudStorageConfig.State getState();
/**
*
*
*
* Optional. The service account to use to write to Cloud Storage. The
* subscription creator or updater that specifies this field must have
* `iam.serviceAccounts.actAs` permission on the service account. If not
* specified, the Pub/Sub
* [service agent](https://cloud.google.com/iam/docs/service-agents),
* service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
*
*
* string service_account_email = 11 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The serviceAccountEmail.
*/
java.lang.String getServiceAccountEmail();
/**
*
*
*
* Optional. The service account to use to write to Cloud Storage. The
* subscription creator or updater that specifies this field must have
* `iam.serviceAccounts.actAs` permission on the service account. If not
* specified, the Pub/Sub
* [service agent](https://cloud.google.com/iam/docs/service-agents),
* service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
*
*
* string service_account_email = 11 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for serviceAccountEmail.
*/
com.google.protobuf.ByteString getServiceAccountEmailBytes();
com.google.pubsub.v1.CloudStorageConfig.OutputFormatCase getOutputFormatCase();
}
