Class PauseEngineRequest (0.38.0)

public final class PauseEngineRequest extends GeneratedMessageV3 implements PauseEngineRequestOrBuilder

Request for pausing training of an engine.

Protobuf type google.cloud.discoveryengine.v1beta.PauseEngineRequest

Static Fields

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PauseEngineRequest getDefaultInstance()
Returns
Type Description
PauseEngineRequest

getDescriptor()

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

newBuilder()

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

newBuilder(PauseEngineRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public PauseEngineRequest getDefaultInstanceForType()
Returns
Type Description
PauseEngineRequest

getName()

public String getName()

Required. The name of the engine to pause. Format: projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The name of the engine to pause. Format: projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<PauseEngineRequest> getParserForType()
Returns
Type Description
Parser<PauseEngineRequest>
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 PauseEngineRequest.Builder newBuilderForType()
Returns
Type Description
PauseEngineRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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