Class GenerateProductImageBackgroundRequest (0.10.0)

public final class GenerateProductImageBackgroundRequest extends GeneratedMessageV3 implements GenerateProductImageBackgroundRequestOrBuilder

Request message for the GenerateProductImageBackground method.

Protobuf type google.shopping.merchant.productstudio.v1alpha.GenerateProductImageBackgroundRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > GenerateProductImageBackgroundRequest

Static Fields

CONFIG_FIELD_NUMBER

public static final int CONFIG_FIELD_NUMBER
Field Value
Type Description
int

INPUT_IMAGE_FIELD_NUMBER

public static final int INPUT_IMAGE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

OUTPUT_CONFIG_FIELD_NUMBER

public static final int OUTPUT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GenerateProductImageBackgroundRequest getDefaultInstance()
Returns
Type Description
GenerateProductImageBackgroundRequest

getDescriptor()

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

newBuilder()

public static GenerateProductImageBackgroundRequest.Builder newBuilder()
Returns
Type Description
GenerateProductImageBackgroundRequest.Builder

newBuilder(GenerateProductImageBackgroundRequest prototype)

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

parseDelimitedFrom(InputStream input)

public static GenerateProductImageBackgroundRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GenerateProductImageBackgroundRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static GenerateProductImageBackgroundRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
GenerateProductImageBackgroundRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static GenerateProductImageBackgroundRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
GenerateProductImageBackgroundRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static GenerateProductImageBackgroundRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GenerateProductImageBackgroundRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static GenerateProductImageBackgroundRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
GenerateProductImageBackgroundRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<GenerateProductImageBackgroundRequest> parser()
Returns
Type Description
Parser<GenerateProductImageBackgroundRequest>

Methods

equals(Object obj)

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

getConfig()

public GenerateImageBackgroundConfig getConfig()

Required. Configuration parameters for the generation of the background.

.google.shopping.merchant.productstudio.v1alpha.GenerateImageBackgroundConfig config = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
GenerateImageBackgroundConfig

The config.

getConfigOrBuilder()

public GenerateImageBackgroundConfigOrBuilder getConfigOrBuilder()

Required. Configuration parameters for the generation of the background.

.google.shopping.merchant.productstudio.v1alpha.GenerateImageBackgroundConfig config = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
GenerateImageBackgroundConfigOrBuilder

getDefaultInstanceForType()

public GenerateProductImageBackgroundRequest getDefaultInstanceForType()
Returns
Type Description
GenerateProductImageBackgroundRequest

getInputImage()

public InputImage getInputImage()

Required. The input image.

.google.shopping.merchant.productstudio.v1alpha.InputImage input_image = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
InputImage

The inputImage.

getInputImageOrBuilder()

public InputImageOrBuilder getInputImageOrBuilder()

Required. The input image.

.google.shopping.merchant.productstudio.v1alpha.InputImage input_image = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
InputImageOrBuilder

getName()

public String getName()

Required. The account for which to generate an image. This acts as a container for the request and does not affect the generation itself. Format: accounts/{account}

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The account for which to generate an image. This acts as a container for the request and does not affect the generation itself. Format: accounts/{account}

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

Returns
Type Description
ByteString

The bytes for name.

getOutputConfig()

public OutputImageConfig getOutputConfig()

Optional. Configuration for how the output image should be returned.

.google.shopping.merchant.productstudio.v1alpha.OutputImageConfig output_config = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
OutputImageConfig

The outputConfig.

getOutputConfigOrBuilder()

public OutputImageConfigOrBuilder getOutputConfigOrBuilder()

Optional. Configuration for how the output image should be returned.

.google.shopping.merchant.productstudio.v1alpha.OutputImageConfig output_config = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
OutputImageConfigOrBuilder

getParserForType()

public Parser<GenerateProductImageBackgroundRequest> getParserForType()
Returns
Type Description
Parser<GenerateProductImageBackgroundRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasConfig()

public boolean hasConfig()

Required. Configuration parameters for the generation of the background.

.google.shopping.merchant.productstudio.v1alpha.GenerateImageBackgroundConfig config = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the config field is set.

hasInputImage()

public boolean hasInputImage()

Required. The input image.

.google.shopping.merchant.productstudio.v1alpha.InputImage input_image = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the inputImage field is set.

hasOutputConfig()

public boolean hasOutputConfig()

Optional. Configuration for how the output image should be returned.

.google.shopping.merchant.productstudio.v1alpha.OutputImageConfig output_config = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the outputConfig field is set.

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 GenerateProductImageBackgroundRequest.Builder newBuilderForType()
Returns
Type Description
GenerateProductImageBackgroundRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public GenerateProductImageBackgroundRequest.Builder toBuilder()
Returns
Type Description
GenerateProductImageBackgroundRequest.Builder

writeTo(CodedOutputStream output)

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