CloudStorageConfig (Cloud Pub/Sub API v1-rev20260227-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.pubsub.model.CloudStorageConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class CloudStorageConfig
extends com.google.api.client.json.GenericJson
```
Configuration for a Cloud Storage subscription.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Pub/Sub API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

CloudStorageConfig()

Constructors
Constructor and Description
`CloudStorageConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CloudStorageConfig`	`clone()`
`AvroConfig`	`getAvroConfig()` Optional.
`String`	`getBucket()` Required.
`String`	`getFilenameDatetimeFormat()` Optional.
`String`	`getFilenamePrefix()` Optional.
`String`	`getFilenameSuffix()` Optional.
`Long`	`getMaxBytes()` Optional.
`String`	`getMaxDuration()` Optional.
`Long`	`getMaxMessages()` Optional.
`String`	`getServiceAccountEmail()` Optional.
`String`	`getState()` Output only.
`TextConfig`	`getTextConfig()` Optional.
`CloudStorageConfig`	`set(String fieldName, Object value)`
`CloudStorageConfig`	`setAvroConfig(AvroConfig avroConfig)` Optional.
`CloudStorageConfig`	`setBucket(String bucket)` Required.
`CloudStorageConfig`	`setFilenameDatetimeFormat(String filenameDatetimeFormat)` Optional.
`CloudStorageConfig`	`setFilenamePrefix(String filenamePrefix)` Optional.
`CloudStorageConfig`	`setFilenameSuffix(String filenameSuffix)` Optional.
`CloudStorageConfig`	`setMaxBytes(Long maxBytes)` Optional.
`CloudStorageConfig`	`setMaxDuration(String maxDuration)` Optional.
`CloudStorageConfig`	`setMaxMessages(Long maxMessages)` Optional.
`CloudStorageConfig`	`setServiceAccountEmail(String serviceAccountEmail)` Optional.
`CloudStorageConfig`	`setState(String state)` Output only.
`CloudStorageConfig`	`setTextConfig(TextConfig textConfig)` Optional.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - CloudStorageConfig
```
public CloudStorageConfig()
```
- Method Detail
  - getAvroConfig
```
public AvroConfig getAvroConfig()
```
    Optional. If set, message data will be written to Cloud Storage in Avro format.
    
    Returns:
    
    value or null for none
  - setAvroConfig
```
public CloudStorageConfig setAvroConfig(AvroConfig avroConfig)
```
    Optional. If set, message data will be written to Cloud Storage in Avro format.
    
    Parameters:
    
    avroConfig - avroConfig or null for none
  - getBucket
```
public 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).
    
    Returns:
    
    value or null for none
  - setBucket
```
public CloudStorageConfig setBucket(String bucket)
```
    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).
    
    Parameters:
    
    bucket - bucket or null for none
  - getFilenameDatetimeFormat
```
public 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).
    
    Returns:
    
    value or null for none
  - setFilenameDatetimeFormat
```
public CloudStorageConfig setFilenameDatetimeFormat(String filenameDatetimeFormat)
```
    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).
    
    Parameters:
    
    filenameDatetimeFormat - filenameDatetimeFormat or null for none
  - getFilenamePrefix
```
public String getFilenamePrefix()
```
    Optional. User-provided prefix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming).
    
    Returns:
    
    value or null for none
  - setFilenamePrefix
```
public CloudStorageConfig setFilenamePrefix(String filenamePrefix)
```
    Optional. User-provided prefix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming).
    
    Parameters:
    
    filenamePrefix - filenamePrefix or null for none
  - getFilenameSuffix
```
public 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 "/".
    
    Returns:
    
    value or null for none
  - setFilenameSuffix
```
public CloudStorageConfig setFilenameSuffix(String filenameSuffix)
```
    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 "/".
    
    Parameters:
    
    filenameSuffix - filenameSuffix or null for none
  - getMaxBytes
```
public Long getMaxBytes()
```
    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.
    
    Returns:
    
    value or null for none
  - setMaxBytes
```
public CloudStorageConfig setMaxBytes(Long maxBytes)
```
    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.
    
    Parameters:
    
    maxBytes - maxBytes or null for none
  - getMaxDuration
```
public String 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 acknowledgment deadline.
    
    Returns:
    
    value or null for none
  - setMaxDuration
```
public CloudStorageConfig setMaxDuration(String maxDuration)
```
    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 acknowledgment deadline.
    
    Parameters:
    
    maxDuration - maxDuration or null for none
  - getMaxMessages
```
public Long getMaxMessages()
```
    Optional. The maximum number of messages that can be written to a Cloud Storage file before a new file is created. Min 1000 messages.
    
    Returns:
    
    value or null for none
  - setMaxMessages
```
public CloudStorageConfig setMaxMessages(Long maxMessages)
```
    Optional. The maximum number of messages that can be written to a Cloud Storage file before a new file is created. Min 1000 messages.
    
    Parameters:
    
    maxMessages - maxMessages or null for none
  - getServiceAccountEmail
```
public 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.
    
    Returns:
    
    value or null for none
  - setServiceAccountEmail
```
public CloudStorageConfig setServiceAccountEmail(String serviceAccountEmail)
```
    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.
    
    Parameters:
    
    serviceAccountEmail - serviceAccountEmail or null for none
  - getState
```
public String getState()
```
    Output only. An output-only field that indicates whether or not the subscription can receive messages.
    
    Returns:
    
    value or null for none
  - setState
```
public CloudStorageConfig setState(String state)
```
    Output only. An output-only field that indicates whether or not the subscription can receive messages.
    
    Parameters:
    
    state - state or null for none
  - getTextConfig
```
public TextConfig getTextConfig()
```
    Optional. If set, message data will be written to Cloud Storage in text format.
    
    Returns:
    
    value or null for none
  - setTextConfig
```
public CloudStorageConfig setTextConfig(TextConfig textConfig)
```
    Optional. If set, message data will be written to Cloud Storage in text format.
    
    Parameters:
    
    textConfig - textConfig or null for none
  - set
```
public CloudStorageConfig set(String fieldName,
                              Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public CloudStorageConfig clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class CloudStorageConfig

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

CloudStorageConfig

Method Detail

getAvroConfig

setAvroConfig

getBucket

setBucket

getFilenameDatetimeFormat

setFilenameDatetimeFormat

getFilenamePrefix

setFilenamePrefix

getFilenameSuffix

setFilenameSuffix

getMaxBytes

setMaxBytes

getMaxDuration

setMaxDuration

getMaxMessages

setMaxMessages

getServiceAccountEmail

setServiceAccountEmail

getState

setState

getTextConfig

setTextConfig

set

clone