Class OutputConfig.GcsDestination (2.49.0)

public static final class OutputConfig.GcsDestination extends GeneratedMessageV3 implements OutputConfig.GcsDestinationOrBuilder

The Google Cloud Storage output destination configuration.

Protobuf type google.cloud.retail.v2.OutputConfig.GcsDestination

Static Fields

OUTPUT_URI_PREFIX_FIELD_NUMBER

public static final int OUTPUT_URI_PREFIX_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static OutputConfig.GcsDestination getDefaultInstance()
Returns
Type Description
OutputConfig.GcsDestination

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static OutputConfig.GcsDestination.Builder newBuilder()
Returns
Type Description
OutputConfig.GcsDestination.Builder

newBuilder(OutputConfig.GcsDestination prototype)

public static OutputConfig.GcsDestination.Builder newBuilder(OutputConfig.GcsDestination prototype)
Parameter
Name Description
prototype OutputConfig.GcsDestination
Returns
Type Description
OutputConfig.GcsDestination.Builder

parseDelimitedFrom(InputStream input)

public static OutputConfig.GcsDestination parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
OutputConfig.GcsDestination
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OutputConfig.GcsDestination parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OutputConfig.GcsDestination
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static OutputConfig.GcsDestination parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
OutputConfig.GcsDestination
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static OutputConfig.GcsDestination parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OutputConfig.GcsDestination
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static OutputConfig.GcsDestination parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
OutputConfig.GcsDestination
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static OutputConfig.GcsDestination parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OutputConfig.GcsDestination
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static OutputConfig.GcsDestination parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
OutputConfig.GcsDestination
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static OutputConfig.GcsDestination parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OutputConfig.GcsDestination
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static OutputConfig.GcsDestination parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
OutputConfig.GcsDestination
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OutputConfig.GcsDestination parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OutputConfig.GcsDestination
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static OutputConfig.GcsDestination parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
OutputConfig.GcsDestination
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static OutputConfig.GcsDestination parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OutputConfig.GcsDestination
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<OutputConfig.GcsDestination> parser()
Returns
Type Description
Parser<GcsDestination>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public OutputConfig.GcsDestination getDefaultInstanceForType()
Returns
Type Description
OutputConfig.GcsDestination

getOutputUriPrefix()

public String getOutputUriPrefix()

Required. The output uri prefix for saving output data to json files. Some mapping examples are as follows: output_uri_prefix sample output(assuming the object is foo.json) =

====================== gs://bucket/ gs://bucket/foo.json gs://bucket/folder/ gs://bucket/folder/foo.json gs://bucket/folder/item_ gs://bucket/folder/item_foo.json

string output_uri_prefix = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The outputUriPrefix.

getOutputUriPrefixBytes()

public ByteString getOutputUriPrefixBytes()

Required. The output uri prefix for saving output data to json files. Some mapping examples are as follows: output_uri_prefix sample output(assuming the object is foo.json) =

====================== gs://bucket/ gs://bucket/foo.json gs://bucket/folder/ gs://bucket/folder/foo.json gs://bucket/folder/item_ gs://bucket/folder/item_foo.json

string output_uri_prefix = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for outputUriPrefix.

getParserForType()

public Parser<OutputConfig.GcsDestination> getParserForType()
Returns
Type Description
Parser<GcsDestination>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public OutputConfig.GcsDestination.Builder newBuilderForType()
Returns
Type Description
OutputConfig.GcsDestination.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected OutputConfig.GcsDestination.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
OutputConfig.GcsDestination.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public OutputConfig.GcsDestination.Builder toBuilder()
Returns
Type Description
OutputConfig.GcsDestination.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException