### Usage Example Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.ZeroCopySupport.DisposableByteString Instances of this class should be used in a try-with-resources to ensure they are released. ```APIDOC try (DisposableByteString disposableByteString = ...) { System.out.println(disposableByteString.byteString().size()); } ``` -------------------------------- ### Storage.BucketGetOption Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage Class for specifying bucket get options. ```APIDOC ## Class: com.google.cloud.storage.Storage.BucketGetOption ### Description Class for specifying bucket get options. ``` -------------------------------- ### Get Storage Client Instance Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.testing.StorageRpcTestBase Returns an instance of the Storage client, which is the entry point for interacting with Cloud Storage. ```java public Storage getStorage() ``` -------------------------------- ### Get Zone Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.control.v2.CreateAnywhereCacheMetadata.Builder Retrieves the zone where the cache instance is running. Example: us-central1-a. ```java public String getZone() ``` -------------------------------- ### Get Default Instance Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.control.v2.CreateAnywhereCacheRequest.Builder Returns the default instance of `CreateAnywhereCacheRequest`. This is often used as a starting point or for comparison. ```java public CreateAnywhereCacheRequest getDefaultInstanceForType() ``` -------------------------------- ### build() Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.StorageSettings.Builder Builds the StorageSettings object. Throws IOException if an error occurs during the build process. ```APIDOC ## build() ### Description Builds the StorageSettings object. ### Method Signature ```java public StorageSettings build() ``` ### Returns #### Success Response - **Type** | **Description** - `StorageSettings` | ### Overrides ClientSettings.Builder.build() ### Exceptions #### Type - `IOException` | Description: ``` -------------------------------- ### Get Write Object Specification Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.StartResumableWriteRequest.Builder Retrieves the specification required to start a resumable write operation. This field is required. ```java public WriteObjectSpec getWriteObjectSpec() ``` -------------------------------- ### Create Bucket Settings Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.stub.StorageStubSettings Retrieves the settings for creating a bucket. Use this to configure the createBucket API call. ```java public UnaryCallSettings createBucketSettings() ``` -------------------------------- ### Get Default Instance Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.control.v2.ListAnywhereCachesResponse.Builder Returns the default instance of ListAnywhereCachesResponse. This is typically used for creating new instances or as a starting point for builders. ```java public ListAnywhereCachesResponse getDefaultInstanceForType() ``` -------------------------------- ### create Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.spi.v1.StorageRpc Creates a new bucket or storage object. ```APIDOC ## create ### Description Creates a new bucket or storage object. ### Method create ### Parameters - **bucket** (Bucket) - The bucket to create. - **options** (Map) - Options for the creation. ### Method create ### Description Creates a new storage object with content. ### Parameters - **storageObject** (StorageObject) - The storage object to create. - **content** (InputStream) - The content of the object. - **options** (Map) - Options for the creation. ``` -------------------------------- ### createBucketSettings Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.stub.StorageStubSettings Returns the object with the settings used for calls to createBucket. ```APIDOC ## createBucketSettings() ### Description Returns the object with the settings used for calls to createBucket. ### Method Signature ```java public UnaryCallSettings createBucketSettings() ``` ### Returns * **Type**: `UnaryCallSettings` ``` -------------------------------- ### Internal Get Field Accessor Table Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.Bucket.SoftDeletePolicy.Builder Internal method to get the field accessor table. ```APIDOC ## internalGetFieldAccessorTable() ### Description Internal method to get the field accessor table for the builder. ### Method Signature ```java protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable() ``` ### Returns - **GeneratedMessage.FieldAccessorTable**: The field accessor table. ### Overrides GeneratedMessage.Builder.internalGetFieldAccessorTable() ``` -------------------------------- ### Get Object Settings Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.stub.StorageStubSettings Retrieves the settings for getting an object. Use this to configure the getObject API call. ```java public UnaryCallSettings getObjectSettings() ``` -------------------------------- ### StorageStubSettings.Builder Methods Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.stub.StorageStubSettings.Builder Methods for configuring various settings of the StorageStub. ```APIDOC ## Methods ### applyToAllUnaryMethods(ApiFunction,Void> settingsUpdater) Applies the given settings updater to all unary methods. ### bidiReadObjectSettings() Returns the settings for the bidiReadObject method. ### bidiWriteObjectSettings() Returns the settings for the bidiWriteObject method. ### build() Builds the StorageStubSettings object. ### cancelResumableWriteSettings() Returns the settings for the cancelResumableWrite method. ### composeObjectSettings() Returns the settings for the composeObject method. ### createBucketSettings() Returns the settings for the createBucket method. ### deleteBucketSettings() Returns the settings for the deleteBucket method. ### deleteObjectSettings() Returns the settings for the deleteObject method. ### getBucketSettings() Returns the settings for the getBucket method. ### getIamPolicySettings() Returns the settings for the getIamPolicy method. ### getObjectSettings() Returns the settings for the getObject method. ### listBucketsSettings() Returns the settings for the listBuckets method. ### listObjectsSettings() Returns the settings for the listObjects method. ### lockBucketRetentionPolicySettings() Returns the settings for the lockBucketRetentionPolicy method. ### moveObjectSettings() Returns the settings for the moveObject method. ### queryWriteStatusSettings() Returns the settings for the queryWriteStatus method. ### readObjectSettings() Returns the settings for the readObject method. ### restoreObjectSettings() Returns the settings for the restoreObject method. ### rewriteObjectSettings() Returns the settings for the rewriteObject method. ### setIamPolicySettings() Returns the settings for the setIamPolicy method. ### startResumableWriteSettings() Returns the settings for the startResumableWrite method. ### testIamPermissionsSettings() Returns the settings for the testIamPermissions method. ### unaryMethodSettingsBuilders() Returns a map of unary method settings builders. ### updateBucketSettings() Returns the settings for the updateBucket method. ### updateObjectSettings() Returns the settings for the updateObject method. ### writeObjectSettings() Returns the settings for the writeObject method. ``` -------------------------------- ### Create Bucket Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.testing.StorageRpcTestBase Creates a new bucket with the specified configuration. ```java public Bucket create(Bucket bucket, Map options) ``` -------------------------------- ### Get Bucket Settings Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.stub.StorageStubSettings Retrieves the settings for getting a bucket. Use this to configure the getBucket API call. ```java public UnaryCallSettings getBucketSettings() ``` -------------------------------- ### simple Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.ParallelCompositeUploadBlobWriteSessionConfig.BufferAllocationStrategy Creates a simple buffer strategy with a specified capacity. ```APIDOC ## simple(int capacity) ### Description Create a simple buffer strategy with a specified capacity. ### Method static ParallelCompositeUploadBlobWriteSessionConfig.BufferAllocationStrategy ### Parameters #### Path Parameters - **capacity** (int) - Description: the number of bytes each buffer should be ### Returns - **Type**: ParallelCompositeUploadBlobWriteSessionConfig.BufferAllocationStrategy - Description: ``` -------------------------------- ### Get Retention Mode Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.Object.RetentionOrBuilder Retrieves the retention mode for the object. Use this method to get the enum type. ```java public abstract Object.Retention.Mode getMode() ``` -------------------------------- ### Initialize BucketInfo.IamConfiguration.Builder Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo.IamConfiguration.Builder Constructs a new Builder for IamConfiguration. This is the starting point for configuring IAM settings. ```java public Builder() ``` -------------------------------- ### Get Default Instance for GetFolderIntelligenceConfigRequest Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.control.v2.GetFolderIntelligenceConfigRequest.Builder Retrieves the default instance of GetFolderIntelligenceConfigRequest. This is often used to get a base configuration object. ```java public GetFolderIntelligenceConfigRequest getDefaultInstanceForType() ``` -------------------------------- ### Bucket.Website Builder Methods Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.Bucket.Website.Builder This section covers the core methods of the Bucket.Website.Builder class, including methods for building the Website object and clearing its state. ```APIDOC ## build() ### Description Builds and returns the immutable Bucket.Website object. ### Method ```java public Bucket.Website build() ``` ### Returns - **Bucket.Website**: The constructed Website object. ``` ```APIDOC ## buildPartial() ### Description Builds the Bucket.Website object, but does not validate the data. ### Method ```java public Bucket.Website buildPartial() ``` ### Returns - **Bucket.Website**: The partially constructed Website object. ``` ```APIDOC ## clear() ### Description Resets all fields in the builder to their default values. ### Method ```java public Bucket.Website.Builder clear() ``` ### Returns - **Bucket.Website.Builder**: The builder instance after clearing. ``` -------------------------------- ### Get IAM Policy Settings Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.stub.StorageStubSettings Retrieves the settings for getting the IAM policy of a resource. Use this to configure the getIamPolicy API call. ```java public UnaryCallSettings getIamPolicySettings() ``` -------------------------------- ### Get HmacKey Access ID Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.HmacKey.HmacKeyMetadata Retrieves the access ID for the HMAC key, which is necessary for operations like getting or deleting the key. ```java public String getAccessId() ``` -------------------------------- ### StorageSettings.Builder Methods Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.StorageSettings.Builder Lists the methods available for configuring various settings of the Storage client. ```APIDOC ## Methods * `applyToAllUnaryMethods(ApiFunction,Void> settingsUpdater)` * `bidiReadObjectSettings()` * `bidiWriteObjectSettings()` * `build()` * `cancelResumableWriteSettings()` * `composeObjectSettings()` * `createBucketSettings()` * `deleteBucketSettings()` * `deleteObjectSettings()` * `getBucketSettings()` * `getIamPolicySettings()` * `getObjectSettings()` * `getStubSettingsBuilder()` * `listBucketsSettings()` * `listObjectsSettings()` * `lockBucketRetentionPolicySettings()` * `moveObjectSettings()` * `queryWriteStatusSettings()` * `readObjectSettings()` * `restoreObjectSettings()` * `rewriteObjectSettings()` * `setIamPolicySettings()` * `startResumableWriteSettings()` * `testIamPermissionsSettings()` * `updateBucketSettings()` * `updateObjectSettings()` * `writeObjectSettings()` ``` -------------------------------- ### Internal Get Map Field Reflection Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.ObjectContexts.Builder Internal method to get a map field reflection accessor by number. Overrides GeneratedMessage.Builder.internalGetMapFieldReflection(int). ```java protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number) ``` -------------------------------- ### Bucket.Versioning.Builder Methods Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.Bucket.Versioning.Builder Provides documentation for the core methods of the Bucket.Versioning.Builder, including building, clearing, and partial building of Versioning configurations. ```APIDOC ## build() ### Description Builds the Bucket.Versioning object. ### Method public Bucket.Versioning build() ### Response #### Success Response (200) - **Type**: Bucket.Versioning - **Description**: The constructed Versioning object. ``` ```APIDOC ## buildPartial() ### Description Builds the Bucket.Versioning object without validating fields. ### Method public Bucket.Versioning buildPartial() ### Response #### Success Response (200) - **Type**: Bucket.Versioning - **Description**: The partially constructed Versioning object. ``` ```APIDOC ## clear() ### Description Clears all fields in the builder, resetting it to its initial state. ### Method public Bucket.Versioning.Builder clear() ### Response #### Success Response (200) - **Type**: Bucket.Versioning.Builder - **Description**: The builder instance after clearing. ``` -------------------------------- ### Instance Defaults Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.control.v2.IntelligenceConfig.TrialConfig Provides methods to get default instances of TrialConfig. ```APIDOC ## getDefaultInstanceForType() ### Description Returns the default instance of the TrialConfig message for its type. ### Method `public IntelligenceConfig.TrialConfig getDefaultInstanceForType()` ### Returns - **IntelligenceConfig.TrialConfig** - The default instance. ``` -------------------------------- ### build Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.control.v2.stub.StorageControlStubSettings.Builder Builds the StorageControlStubSettings object. ```APIDOC ## build() ```java public StorageControlStubSettings build() ``` ### Description Builds the StorageControlStubSettings object. **Returns** --- **Type** | **Description** `StorageControlStubSettings` | **Overrides** StubSettings.Builder.build() **Exceptions** --- **Type** | **Description** `IOException` | ``` -------------------------------- ### Get HmacKey Creation Time (Long) Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.HmacKey.HmacKeyMetadata Deprecated method to get the creation time of this HMAC key as a Long. Use getCreateTimeOffsetDateTime() instead. ```java public Long getCreateTime() ``` -------------------------------- ### Internal Get Mutable Map Field Reflection Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.ObjectContexts.Builder Internal method to get a mutable map field reflection accessor by number. Overrides GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int). ```java protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number) ``` -------------------------------- ### IntelligenceConfig.TrialConfig.Builder Methods Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.control.v2.IntelligenceConfig.TrialConfig.Builder Provides a list of methods for the IntelligenceConfig.TrialConfig.Builder class, including methods for building, clearing, merging, and setting fields. ```APIDOC ## Class IntelligenceConfig.TrialConfig.Builder ### Description This class is a builder for the `IntelligenceConfig.TrialConfig` message, allowing for the construction and modification of trial configurations. ### Methods * **build()**: Builds the `IntelligenceConfig.TrialConfig` message. * **buildPartial()**: Builds a partial `IntelligenceConfig.TrialConfig` message without validating all fields. * **clear()**: Clears all fields in the builder. * **clearExpireTime()**: Clears the `expireTime` field. * **getDefaultInstanceForType()**: Gets the default instance of the builder's message type. * **getDescriptorForType()**: Gets the descriptor for the message type. * **getExpireTime()**: Gets the `expireTime` field. * **getExpireTimeBuilder()**: Gets a builder for the `expireTime` field. * **getExpireTimeOrBuilder()**: Gets the `expireTime` field or its builder. * **hasExpireTime()**: Checks if the `expireTime` field is set. * **internalGetFieldAccessorTable()**: Internal method to get the field accessor table. * **isInitialized()**: Checks if the message is initialized. * **mergeExpireTime(Timestamp value)**: Merges the given `Timestamp` value into the `expireTime` field. * **mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)**: Merges the message from a `CodedInputStream`. * **mergeFrom(Message other)**: Merges the message from another `Message`. * **mergeFrom(IntelligenceConfig.TrialConfig other)**: Merges the message from another `IntelligenceConfig.TrialConfig`. * **setExpireTime(Timestamp value)**: Sets the `expireTime` field to the given `Timestamp` value. * **setExpireTime(Timestamp.Builder builderForValue)**: Sets the `expireTime` field using a `Timestamp.Builder`. ``` -------------------------------- ### Get Acl.User for all users Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Acl.User Use this static method to get a predefined Acl.User object representing all users, including anonymous users. This is typically used for public access scenarios. ```java public static Acl.User ofAllUsers() ``` -------------------------------- ### IntelligenceConfig.TrialConfig.Builder Static Methods Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.control.v2.IntelligenceConfig.TrialConfig.Builder This section details the static methods available on the IntelligenceConfig.TrialConfig.Builder. ```APIDOC ## Static Methods ### getDescriptor() ```java public static final Descriptors.Descriptor getDescriptor() ``` **Returns** --- **Type** | **Description** `Descriptor` | Returns the descriptor for the TrialConfig message type. ``` -------------------------------- ### Get Acl.User for all authenticated users Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Acl.User Use this static method to get a predefined Acl.User object representing all authenticated Google Cloud users. This is often used for granting broad access. ```java public static Acl.User ofAllAuthenticatedUsers() ``` -------------------------------- ### getTeamBytes() Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.ProjectTeam.Builder Gets the team as a ByteString. ```APIDOC ## getTeamBytes() ### Description Gets the optional team as bytes. ### Method ```java public ByteString getTeamBytes() ``` ### Returns - **ByteString**: The bytes for team. ``` -------------------------------- ### Bucket.ObjectRetention.Builder Methods Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.Bucket.ObjectRetention.Builder Provides a list of methods for building and configuring Bucket.ObjectRetention objects. ```APIDOC ## Class Bucket.ObjectRetention.Builder ### Description Builder for `Bucket.ObjectRetention` objects. This class allows for the configuration of object retention properties for a bucket. ### Methods * **build()**: Builds and returns the `Bucket.ObjectRetention` object. * **buildPartial()**: Builds a partial `Bucket.ObjectRetention` object. * **clear()**: Clears all fields in the builder. * **clearEnabled()**: Clears the 'enabled' field. * **getDefaultInstanceForType()**: Gets the default instance for the current type. * **getDescriptorForType()**: Gets the descriptor for the type. * **getEnabled()**: Gets the value of the 'enabled' field. * **internalGetFieldAccessorTable()**: Internal method to get the field accessor table. * **isInitialized()**: Checks if the object is initialized. * **mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)**: Merges data from a `CodedInputStream`. * **mergeFrom(Message other)**: Merges data from another `Message`. * **mergeFrom(Bucket.ObjectRetention other)**: Merges data from another `Bucket.ObjectRetention` object. * **setEnabled(boolean value)**: Sets the 'enabled' field to the specified boolean value. ``` -------------------------------- ### Bucket.Website.Builder Methods Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.Bucket.Website.Builder Provides methods for building and configuring the Website object for a Cloud Storage bucket, including setting the main page suffix and not found page. ```APIDOC ## Class Bucket.Website.Builder ### Description Properties of a bucket related to accessing the contents as a static website. For details, see hosting a static website using Cloud Storage. ### Methods - **build()**: Builds the `Bucket.Website` object. - **buildPartial()**: Builds a partial `Bucket.Website` object. - **clear()**: Clears all fields in the builder. - **clearMainPageSuffix()**: Clears the main page suffix. - **clearNotFoundPage()**: Clears the not found page. - **getDefaultInstanceForType()**: Gets the default instance for the builder's type. - **getDescriptor()**: Gets the descriptor for the `Bucket.Website` message. - **getDescriptorForType()**: Gets the descriptor for the message type. - **getMainPageSuffix()**: Gets the main page suffix. - **getMainPageSuffixBytes()**: Gets the main page suffix as bytes. - **getNotFoundPage()**: Gets the not found page. - **getNotFoundPageBytes()**: Gets the not found page as bytes. - **isInitialized()**: Checks if the message is initialized. - **mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)**: Merges from the given input stream. - **mergeFrom(Message other)**: Merges from another message. - **mergeFrom(Bucket.Website other)**: Merges from another `Bucket.Website` object. - **setMainPageSuffix(String value)**: Sets the main page suffix. - **setMainPageSuffixBytes(ByteString value)**: Sets the main page suffix as bytes. - **setNotFoundPage(String value)**: Sets the not found page. - **setNotFoundPageBytes(ByteString value)**: Sets the not found page as bytes. ``` -------------------------------- ### getTeam() Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.ProjectTeam.Builder Gets the optional team. ```APIDOC ## getTeam() ### Description Gets the optional team. ### Method ```java public String getTeam() ``` ### Returns - **String**: The team. ``` -------------------------------- ### getStorage Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.spi.v1.StorageRpc Gets the Storage object. ```APIDOC ## getStorage ### Description Gets the Storage object. ### Method getStorage ### Response - **Storage** - The Storage object. ``` -------------------------------- ### build() Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo.IamConfiguration.Builder Builds an IamConfiguration object. ```APIDOC ## build() ### Description Builds an `IamConfiguration` object. ### Method ```java public BucketInfo.IamConfiguration build() ``` ### Returns * **Type**: `BucketInfo.IamConfiguration` * **Description**: The constructed IamConfiguration object. ``` -------------------------------- ### getOrg() Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.control.v2.IntelligenceConfigName.OrgLocationBuilder Gets the organization string. ```APIDOC ### getOrg() ```java public String getOrg() ``` **Returns** --- **Type** | **Description** `String` | ``` -------------------------------- ### New Builder with Client Context Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.stub.StorageStubSettings Returns a new builder for StorageStubSettings, initialized with the provided ClientContext. This allows for pre-configured client context settings. ```java public static StorageStubSettings.Builder newBuilder(ClientContext clientContext) ``` -------------------------------- ### build() Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo.HierarchicalNamespace.Builder Builds the HierarchicalNamespace configuration. ```APIDOC ## build() ### Description Builds the HierarchicalNamespace configuration. ### Method Signature ```java public BucketInfo.HierarchicalNamespace build() ``` ### Returns - **Type**: BucketInfo.HierarchicalNamespace - **Description**: The constructed HierarchicalNamespace object. ``` -------------------------------- ### getLocation() Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.control.v2.IntelligenceConfigName.OrgLocationBuilder Gets the location string. ```APIDOC ### getLocation() ```java public String getLocation() ``` **Returns** --- **Type** | **Description** `String` | ``` -------------------------------- ### createBucket Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.testing.StorageRpcTestBase Creates a new bucket with the specified configuration. ```APIDOC ## create(Bucket bucket, Map options) ### Description Creates a new bucket. ### Method Signature public Bucket create(Bucket bucket, Map options) ### Parameters * **bucket** (Bucket) - The bucket to create. * **options** (Map) - Options for bucket creation. ### Returns * **Type**: Bucket * **Description**: The created bucket. ``` -------------------------------- ### getSourceObject Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.RewriteObjectRequest.Builder Gets the name of the source object. ```APIDOC ## getSourceObject() ### Description Required. Name of the source object. ### Returns * **String** - The sourceObject. ``` -------------------------------- ### SignatureInfo.Builder Constructors Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.SignatureInfo.Builder Provides details on how to initialize a SignatureInfo.Builder. ```APIDOC ## Builder(HttpMethod httpVerb, long expiration, URI canonicalizedResource) ### Description Constructs builder. ### Parameters #### Path Parameters - **httpVerb** (HttpMethod) - the HTTP method - **expiration** (long) - the EPOX expiration date - **canonicalizedResource** (URI) - the resource URI ## Builder(SignatureInfo signatureInfo) ### Description Initializes a builder with an existing SignatureInfo object. ### Parameters #### Path Parameters - **signatureInfo** (SignatureInfo) - the SignatureInfo object to copy ``` -------------------------------- ### getDescriptorForType() Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.WriteObjectSpec.Builder Gets the descriptor for the message type. ```APIDOC ## getDescriptorForType() ### Description Gets the descriptor for the message type. ### Method ```java public Descriptors.Descriptor getDescriptorForType() ``` ### Returns - **Type**: `Descriptor` - **Description**: **Overrides** GeneratedMessage.Builder.getDescriptorForType() ``` -------------------------------- ### Enable OpenTelemetry Tracing with StorageOptions Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.StorageOptions.DefaultStorageFactory Use this method to enable OpenTelemetry tracing and provide a custom OpenTelemetry instance for the client. The builder pattern is used for configuration. ```java public abstract StorageOptions.Builder setOpenTelemetry(OpenTelemetry openTelemetry) ``` -------------------------------- ### getProjectNumberBytes() Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.ProjectTeam.Builder Gets the project number as a ByteString. ```APIDOC ## getProjectNumberBytes() ### Description Gets the optional project number as bytes. ### Method ```java public ByteString getProjectNumberBytes() ``` ### Returns - **ByteString**: The bytes for projectNumber. ``` -------------------------------- ### Constructors Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.control.v2.stub.StorageControlStubSettings.Builder Provides options for creating a new instance of the StorageControlStubSettings.Builder. ```APIDOC ## Constructors ### Builder() Default constructor. ### Builder(ClientContext clientContext) Constructor with a client context. ### Builder(StorageControlStubSettings settings) Constructor with existing settings. ``` -------------------------------- ### getProjectNumber() Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.ProjectTeam.Builder Gets the optional project number. ```APIDOC ## getProjectNumber() ### Description Gets the optional project number. ### Method ```java public String getProjectNumber() ``` ### Returns - **String**: The projectNumber. ``` -------------------------------- ### list(Map options) Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.spi.v1.StorageRpc Lists the buckets within the project. ```APIDOC ## list(Map options) ### Description Lists the project's buckets. ### Parameters #### Query Parameters - **options** (Map) - Description ### Returns #### Success Response - **Tuple>** - Description ``` -------------------------------- ### getDescriptorForType() Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.Bucket.Lifecycle.Builder Gets the descriptor for the Bucket.Lifecycle type. ```APIDOC ## getDescriptorForType() ### Description Returns the descriptor for the `Bucket.Lifecycle` message type. This provides metadata about the message structure. This method overrides the `getDescriptorForType()` from `GeneratedMessage.Builder`. ### Method Signature ```java public Descriptors.Descriptor getDescriptorForType() ``` ### Returns * **Descriptor** - The descriptor for the `Bucket.Lifecycle` type. ``` -------------------------------- ### getWriteHandleOrBuilder Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.BidiWriteObjectRedirectedError.Builder Gets the write handle or its builder. ```APIDOC ## getWriteHandleOrBuilder() ### Description Gets the write handle or its builder. If set, the client must use this in an AppendObjectSpec first_message when retrying the write stream. If not set, clients might retry the original request. `optional .google.storage.v2.BidiWriteHandle write_handle = 2;` ### Returns - **Type**: `BidiWriteHandleOrBuilder` - **Description**: The write handle or its builder. ``` -------------------------------- ### Create Folder Settings Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.control.v2.stub.StorageControlStubSettings.Builder Returns a builder for configuring the settings used for createFolder calls. ```java public UnaryCallSettings.Builder createFolderSettings() ``` -------------------------------- ### getWriteHandleBuilder Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.BidiWriteObjectRedirectedError.Builder Gets a builder for the write handle. ```APIDOC ## getWriteHandleBuilder() ### Description Gets a builder for the write handle. If set, the client must use this in an AppendObjectSpec first_message when retrying the write stream. If not set, clients might retry the original request. `optional .google.storage.v2.BidiWriteHandle write_handle = 2;` ### Returns - **Type**: `BidiWriteHandle.Builder` - **Description**: The builder for the write handle. ``` -------------------------------- ### build() Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BlobInfo.ObjectContexts.Builder Builds the BlobInfo.ObjectContexts object. ```APIDOC ## build() ### Description Builds the BlobInfo.ObjectContexts object. ### Method ```java public BlobInfo.ObjectContexts build() ``` ### Returns - **Type**: BlobInfo.ObjectContexts - **Description**: ``` -------------------------------- ### getDescriptorForType() Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.control.v2.RenameFolderMetadata.Builder Gets the descriptor for the RenameFolderMetadata type. ```APIDOC ## getDescriptorForType() ### Description Gets the descriptor for the RenameFolderMetadata type. ### Method ```java public Descriptors.Descriptor getDescriptorForType() ``` ### Returns - **Type**: `Descriptor` ### Overrides GeneratedMessage.Builder.getDescriptorForType() ``` -------------------------------- ### Static Methods Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.HmacKey.HmacKeyMetadata Static methods for creating HmacKeyMetadata instances. ```APIDOC ## newBuilder(ServiceAccount serviceAccount) ### Description Creates a new builder for HmacKeyMetadata. ### Method ```java public static HmacKey.HmacKeyMetadata.Builder newBuilder(ServiceAccount serviceAccount) ``` ### Parameters #### Path Parameters - **serviceAccount** (ServiceAccount) - The ServiceAccount object. ### Returns #### Success Response - **Type**: HmacKey.HmacKeyMetadata.Builder - **Description**: A new builder instance. ``` ```APIDOC ## of(ServiceAccount serviceAccount, String accessId, String projectId) ### Description Creates an HmacKeyMetadata instance from the provided details. ### Method ```java public static HmacKey.HmacKeyMetadata of(ServiceAccount serviceAccount, String accessId, String projectId) ``` ### Parameters #### Path Parameters - **serviceAccount** (ServiceAccount) - The ServiceAccount object. - **accessId** (String) - The access ID of the HMAC key. - **projectId** (String) - The project ID associated with the HMAC key. ### Returns #### Success Response - **Type**: HmacKey.HmacKeyMetadata - **Description**: An HmacKeyMetadata instance. ``` -------------------------------- ### Bucket.Autoclass.Builder Methods Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.Bucket.Autoclass.Builder Provides documentation for the build, buildPartial, and clear methods of the Bucket.Autoclass.Builder class. ```APIDOC ## build() ### Description Builds the Autoclass configuration. ### Method ```java public Bucket.Autoclass build() ``` ### Returns - **Bucket.Autoclass**: The constructed Autoclass object. ## buildPartial() ### Description Builds the Autoclass configuration without validating all fields. ### Method ```java public Bucket.Autoclass buildPartial() ``` ### Returns - **Bucket.Autoclass**: The partially constructed Autoclass object. ## clear() ### Description Clears all fields in the Autoclass builder, resetting it to its initial state. ### Method ```java public Bucket.Autoclass.Builder clear() ``` ### Returns - **Bucket.Autoclass.Builder**: The builder instance after clearing. ### Overrides GeneratedMessage.Builder.clear() ``` -------------------------------- ### get Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.spi.v1.StorageRpc Retrieves a bucket or storage object. ```APIDOC ## get ### Description Retrieves a bucket or storage object. ### Method get ### Parameters - **bucket** (Bucket) - The bucket to retrieve. - **options** (Map) - Options for the retrieval. ### Method get ### Description Retrieves a storage object. ### Parameters - **object** (StorageObject) - The storage object to retrieve. - **options** (Map) - Options for the retrieval. ### Response - **StorageObject** - The retrieved storage object. ``` -------------------------------- ### getProject() Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.control.v2.BucketName.Builder Gets the project ID from the builder. ```APIDOC ## getProject() ### Description Gets the project ID from the builder. ### Method Signature ```java public String getProject() ``` ### Returns - **Type**: `String` - **Description**: The project ID. ``` -------------------------------- ### Instance Methods Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.control.v2.stub.HttpJsonStorageControlStub Methods available on an instance of the Storage Control stub. ```APIDOC ## Methods ### awaitTermination(long duration, TimeUnit unit) Waits for the stub to terminate for a given duration. ### close() Closes the stub and releases any resources. ### createAnywhereCacheCallable() Returns a callable for creating an Anywhere Cache. ### createFolderCallable() Returns a callable for creating a folder. ### createManagedFolderCallable() Returns a callable for creating a managed folder. ### deleteFolderCallable() Returns a callable for deleting a folder. ### deleteFolderRecursiveCallable() Returns a callable for recursively deleting a folder. ### deleteManagedFolderCallable() Returns a callable for deleting a managed folder. ### disableAnywhereCacheCallable() Returns a callable for disabling an Anywhere Cache. ### getAnywhereCacheCallable() Returns a callable for getting an Anywhere Cache. ### getFolderCallable() Returns a callable for getting a folder. ### getFolderIntelligenceConfigCallable() Returns a callable for getting folder intelligence configuration. ### getHttpJsonOperationsStub() Returns the HTTP JSON operations stub. ### getIamPolicyCallable() Returns a callable for getting the IAM policy. ### getManagedFolderCallable() Returns a callable for getting a managed folder. ### getOrganizationIntelligenceConfigCallable() Returns a callable for getting organization intelligence configuration. ### getProjectIntelligenceConfigCallable() Returns a callable for getting project intelligence configuration. ### getStorageLayoutCallable() Returns a callable for getting the storage layout. ### isShutdown() Checks if the stub has been shut down. ### isTerminated() Checks if the stub has been terminated. ### listAnywhereCachesCallable() Returns a callable for listing Anywhere Caches. ### listFoldersCallable() Returns a callable for listing folders. ### listManagedFoldersCallable() Returns a callable for listing managed folders. ### pauseAnywhereCacheCallable() Returns a callable for pausing an Anywhere Cache. ### renameFolderCallable() Returns a callable for renaming a folder. ### resumeAnywhereCacheCallable() Returns a callable for resuming an Anywhere Cache. ### setIamPolicyCallable() Returns a callable for setting the IAM policy. ### shutdown() Initiates a graceful shutdown of the stub. ### shutdownNow() Initiates an immediate shutdown of the stub. ### testIamPermissionsCallable() Returns a callable for testing IAM permissions. ### updateAnywhereCacheCallable() Returns a callable for updating an Anywhere Cache. ### updateFolderIntelligenceConfigCallable() Returns a callable for updating folder intelligence configuration. ### updateOrganizationIntelligenceConfigCallable() Returns a callable for updating organization intelligence configuration. ### updateProjectIntelligenceConfigCallable() Returns a callable for updating project intelligence configuration. ``` -------------------------------- ### Configuring Retry Settings for Delete Bucket Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.stub.StorageStubSettings This example demonstrates how to configure the retry settings for the deleteBucket operation using the StorageStubSettings builder. It shows how to modify initial delay, RPC timeouts, maximum attempts, and retry multipliers. ```APIDOC ## Configure Retry Settings for Delete Bucket ### Description This snippet shows how to customize the retry behavior for the `deleteBucket` operation by modifying its `RetrySettings`. ### Method Signature `StorageStubSettings.newBuilder().deleteBucketSettings().setRetrySettings(...).build()` ### Example ```java // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library StorageStubSettings.Builder storageSettingsBuilder = StorageStubSettings.newBuilder(); storageSettingsBuilder .deleteBucketSettings() .setRetrySettings( storageSettingsBuilder .deleteBucketSettings() .getRetrySettings() .toBuilder() .setInitialRetryDelayDuration(Duration.ofSeconds(1)) .setInitialRpcTimeoutDuration(Duration.ofSeconds(5)) .setMaxAttempts(5) .setMaxRetryDelayDuration(Duration.ofSeconds(30)) .setMaxRpcTimeoutDuration(Duration.ofSeconds(60)) .setRetryDelayMultiplier(1.3) .setRpcTimeoutMultiplier(1.5) .setTotalTimeoutDuration(Duration.ofSeconds(300)) .build()); StorageStubSettings storageSettings = storageSettingsBuilder.build(); ``` ### Notes Refer to the Client Side Retry Guide for additional support in setting retries. ``` -------------------------------- ### getBucket() Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.control.v2.BucketName.Builder Gets the bucket name from the builder. ```APIDOC ## getBucket() ### Description Gets the bucket name from the builder. ### Method Signature ```java public String getBucket() ``` ### Returns - **Type**: `String` - **Description**: The bucket name. ``` -------------------------------- ### getSourceObjectBytes Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.RewriteObjectRequest.Builder Gets the source object name as bytes. ```APIDOC ## getSourceObjectBytes() ### Description Required. Name of the source object. ### Returns * **ByteString** - The bytes for sourceObject. ``` -------------------------------- ### CreateBucket Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2 Creates a new bucket. ```APIDOC ## CreateBucket ### Description Creates a new bucket. ### Method POST ### Endpoint /v2/projects/{project}/buckets ### Request Body - **bucket** (Bucket) - Required - The bucket to create. - **bucketId** (string) - Required - The ID of the bucket to create. ### Response #### Success Response (200) - **Bucket** (Bucket) - The created bucket. ``` -------------------------------- ### Build StorageControlStubSettings Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.control.v2.stub.StorageControlStubSettings.Builder Builds and returns an instance of StorageControlStubSettings. This method may throw an IOException. ```java public StorageControlStubSettings build() ``` -------------------------------- ### getSourceBucketBytes Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.RewriteObjectRequest.Builder Gets the source bucket name as bytes. ```APIDOC ## getSourceBucketBytes() ### Description Required. Name of the bucket in which to find the source object. ### Returns * **ByteString** - The bytes for sourceBucket. ``` -------------------------------- ### Get Descriptor Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.Bucket.SoftDeletePolicy.Builder Retrieves the descriptor for the SoftDeletePolicy type. ```APIDOC ## getDescriptorForType() ### Description Retrieves the descriptor for the SoftDeletePolicy type. ### Method Signature ```java public Descriptors.Descriptor getDescriptorForType() ``` ### Returns - **Descriptors.Descriptor**: The descriptor for the SoftDeletePolicy type. ### Overrides GeneratedMessage.Builder.getDescriptorForType() ``` -------------------------------- ### BucketInfo.Logging.Builder Constructors Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo.Logging.Builder Provides documentation for the constructors available in the BucketInfo.Logging.Builder class. ```APIDOC ## Builder() ```java public Builder() ``` ### Description Initializes a new instance of the `Builder` class. ``` -------------------------------- ### getBucket() Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.CreateBucketRequest.Builder Retrieves the bucket property, which contains optional properties of the new bucket being inserted. The bucket name is specified in the `bucket_id` field. Populating `bucket.name` field results in an error. The project of the bucket must be specified in the `bucket.project` field. This field must be in `projects/{projectIdentifier}` format, {projectIdentifier} can be the project ID or project number. The `parent` field must be either empty or `projects/_`. ```APIDOC ## getBucket() ### Description Retrieves the optional properties of the new bucket being inserted. ### Method `public Bucket getBucket()` ### Returns `Bucket` - The bucket. ``` -------------------------------- ### getRetentionDuration Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.Bucket.RetentionPolicy.Builder Gets the retention duration for objects in the bucket. ```APIDOC ## getRetentionDuration() ### Description Gets the duration that objects need to be retained. Retention duration must be greater than zero and less than 100 years. Note that enforcement of retention periods less than a day is not guaranteed and should only be used for testing purposes. Any `nanos` value specified is rounded down to the nearest second. ### Method Signature `public Duration getRetentionDuration()` ### Returns - **Type**: `Duration` - **Description**: The retention duration for objects in the bucket. ``` -------------------------------- ### getDescriptorForType() Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.Bucket.Versioning.Builder Gets the descriptor for the Versioning configuration type. ```APIDOC ## getDescriptorForType() ### Description Gets the descriptor for the Versioning configuration type. ### Method `public Descriptors.Descriptor getDescriptorForType()` ### Returns - **Descriptor** - The descriptor for the type. ``` -------------------------------- ### build() Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.control.v2.IntelligenceConfigName.OrgLocationBuilder Builds the IntelligenceConfigName object. ```APIDOC ## Methods ### build() ```java public IntelligenceConfigName build() ``` **Returns** --- **Type** | **Description** `IntelligenceConfigName` | ``` -------------------------------- ### Bucket.Lifecycle.Rule.Action.Builder Methods Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.Bucket.Lifecycle.Rule.Action.Builder Provides a list of methods for constructing and modifying Bucket.Lifecycle.Rule.Action objects. ```APIDOC ## Class Bucket.Lifecycle.Rule.Action.Builder An action to take on an object. Protobuf type `google.storage.v2.Bucket.Lifecycle.Rule.Action` ### Methods * **build()**: Builds the `Bucket.Lifecycle.Rule.Action` object. * **buildPartial()**: Builds a partial `Bucket.Lifecycle.Rule.Action` object. * **clear()**: Clears all fields in the builder. * **clearStorageClass()**: Clears the storage class field. * **clearType()**: Clears the type field. * **getDefaultInstanceForType()**: Gets the default instance for the builder's type. * **getDescriptor()**: Gets the descriptor for the `Bucket.Lifecycle.Rule.Action` message. * **getDescriptorForType()**: Gets the descriptor for the builder's type. * **getStorageClass()**: Gets the storage class. * **getStorageClassBytes()**: Gets the storage class as a ByteString. * **getType()**: Gets the action type. * **getTypeBytes()**: Gets the action type as a ByteString. * **isInitialized()**: Checks if the message is initialized. * **mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)**: Merges from a CodedInputStream. * **mergeFrom(Message other)**: Merges from another Message. * **mergeFrom(Bucket.Lifecycle.Rule.Action other)**: Merges from another `Bucket.Lifecycle.Rule.Action`. * **setStorageClass(String value)**: Sets the storage class. * **setStorageClassBytes(ByteString value)**: Sets the storage class as a ByteString. * **setType(String value)**: Sets the action type. * **setTypeBytes(ByteString value)**: Sets the action type as a ByteString. ``` -------------------------------- ### getDefaultInstanceForType Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.control.v2.UpdateFolderIntelligenceConfigRequest.Builder Gets the default instance of the request builder. ```APIDOC ## getDefaultInstanceForType() ### Description Gets the default instance of the request builder. ### Method Signature ```java public UpdateFolderIntelligenceConfigRequest getDefaultInstanceForType() ``` ### Returns - `UpdateFolderIntelligenceConfigRequest`: The default instance. ``` -------------------------------- ### createBucketSettings Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.StorageSettings.Builder Returns the builder for the settings used for calls to createBucket. ```APIDOC ## createBucketSettings() ### Description Returns the builder for the settings used for calls to createBucket. ### Method Signature ```java public UnaryCallSettings.Builder createBucketSettings() ``` ### Returns - **Type**: `Builder` ``` -------------------------------- ### getAnywhereCachesCount() Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.control.v2.ListAnywhereCachesResponse.Builder Gets the number of AnywhereCache items in the list. ```APIDOC ## getAnywhereCachesCount() ### Description Returns the total number of AnywhereCache objects currently in the list. ### Method ```java public int getAnywhereCachesCount() ``` ### Returns - **int** - The count of AnywhereCache items. ``` -------------------------------- ### getCurrentUploadOffset Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.spi.v1.StorageRpc Gets the current offset of a resumable upload. ```APIDOC ## getCurrentUploadOffset ### Description Gets the current offset of a resumable upload. ### Method getCurrentUploadOffset ### Parameters - **uploadId** (String) - The ID of the upload. ### Response - **long** - The current upload offset. ``` -------------------------------- ### Builder Methods Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.Bucket.Lifecycle.Rule.Action.Builder Provides documentation for the core methods of the Bucket.Lifecycle.Rule.Action.Builder, including build, buildPartial, and clear. ```APIDOC ## Methods ### build() ```java public Bucket.Lifecycle.Rule.Action build() ``` **Returns** --- **Type** | **Description** `Bucket.Lifecycle.Rule.Action` | ### buildPartial() ```java public Bucket.Lifecycle.Rule.Action buildPartial() ``` **Returns** --- **Type** | **Description** `Bucket.Lifecycle.Rule.Action` | ### clear() ```java public Bucket.Lifecycle.Rule.Action.Builder clear() ``` **Returns** --- **Type** | **Description** `Bucket.Lifecycle.Rule.Action.Builder` | **Overrides** GeneratedMessage.Builder.clear() ``` -------------------------------- ### Create New Builder Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.control.v2.IntelligenceConfig.TrialConfig Creates a new builder instance for IntelligenceConfig.TrialConfig. Use this to construct new configuration objects. ```java public static IntelligenceConfig.TrialConfig.Builder newBuilder() ``` -------------------------------- ### StorageSettings.Builder Constructors Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.StorageSettings.Builder Provides constructors for initializing the StorageSettings.Builder. ```APIDOC ## Constructors * `Builder()` * `Builder(ClientContext clientContext)` * `Builder(StorageSettings settings)` * `Builder(StorageStubSettings.Builder stubSettings)` ``` -------------------------------- ### Storage.BlobGetOption Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage Class for specifying blob get options. ```APIDOC ## Class: com.google.cloud.storage.Storage.BlobGetOption ### Description Class for specifying blob get options. ``` -------------------------------- ### byteString() Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.ZeroCopySupport.DisposableByteString Get the ByteString representation of the underlying resources. ```APIDOC public abstract ByteString byteString() ``` -------------------------------- ### Methods Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.control.v2.stub.StorageControlStubSettings.Builder Configures various settings for StorageControl stub operations. ```APIDOC ## Methods ### applyToAllUnaryMethods(ApiFunction,Void> settingsUpdater) Applies a given function to all unary method settings. ### build() Builds the StorageControlStubSettings object. ### createAnywhereCacheOperationSettings() Returns a builder for the settings of the create anywhere cache operation. ### createAnywhereCacheSettings() Returns a builder for the settings of the create anywhere cache. ### createFolderSettings() Returns a builder for the settings of the create folder. ### createManagedFolderSettings() Returns a builder for the settings of the create managed folder. ### deleteFolderRecursiveOperationSettings() Returns a builder for the settings of the delete folder recursive operation. ### deleteFolderRecursiveSettings() Returns a builder for the settings of the delete folder recursive. ### deleteFolderSettings() Returns a builder for the settings of the delete folder. ### deleteManagedFolderSettings() Returns a builder for the settings of the delete managed folder. ### disableAnywhereCacheSettings() Returns a builder for the settings of the disable anywhere cache. ### getAnywhereCacheSettings() Returns a builder for the settings of the get anywhere cache. ### getFolderIntelligenceConfigSettings() Returns a builder for the settings of the get folder intelligence config. ### getFolderSettings() Returns a builder for the settings of the get folder. ### getIamPolicySettings() Returns a builder for the settings of the get IAM policy. ### getManagedFolderSettings() Returns a builder for the settings of the get managed folder. ### getOrganizationIntelligenceConfigSettings() Returns a builder for the settings of the get organization intelligence config. ### getProjectIntelligenceConfigSettings() Returns a builder for the settings of the get project intelligence config. ### getStorageLayoutSettings() Returns a builder for the settings of the get storage layout. ### listAnywhereCachesSettings() Returns a builder for the settings of the list anywhere caches. ### listFoldersSettings() Returns a builder for the settings of the list folders. ### listManagedFoldersSettings() Returns a builder for the settings of the list managed folders. ### pauseAnywhereCacheSettings() Returns a builder for the settings of the pause anywhere cache. ### renameFolderOperationSettings() Returns a builder for the settings of the rename folder operation. ### renameFolderSettings() Returns a builder for the settings of the rename folder. ### resumeAnywhereCacheSettings() Returns a builder for the settings of the resume anywhere cache. ### setIamPolicySettings() Returns a builder for the settings of the set IAM policy. ### testIamPermissionsSettings() Returns a builder for the settings of the test IAM permissions. ### unaryMethodSettingsBuilders() Returns a map of unary method settings builders. ### updateAnywhereCacheOperationSettings() Returns a builder for the settings of the update anywhere cache operation. ### updateAnywhereCacheSettings() Returns a builder for the settings of the update anywhere cache. ### updateFolderIntelligenceConfigSettings() Returns a builder for the settings of the update folder intelligence config. ### updateOrganizationIntelligenceConfigSettings() Returns a builder for the settings of the update organization intelligence config. ### updateProjectIntelligenceConfigSettings() Returns a builder for the settings of the update project intelligence config. ``` -------------------------------- ### isShutdown Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.control.v2.stub.HttpJsonStorageControlStub Returns true if this service has been started and is shut down. ```APIDOC ## isShutdown() ### Description Returns true if this service has been started and is shut down. ### Method ```java public boolean isShutdown() ``` ### Returns - **Type**: `boolean` ``` -------------------------------- ### Initialization Check Source: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.control.v2.IntelligenceConfig.TrialConfig Checks if the TrialConfig object has been fully initialized. ```APIDOC ## isInitialized() ### Description Checks if all required fields in the TrialConfig message have been set. ### Method `public final boolean isInitialized()` ### Returns - **boolean** - true if the message is initialized, false otherwise. ### Overrides GeneratedMessage.isInitialized() ```