Class ExecuteExtensionRequest (3.47.0)

public final class ExecuteExtensionRequest extends GeneratedMessageV3 implements ExecuteExtensionRequestOrBuilder

Request message for ExtensionExecutionService.ExecuteExtension.

Protobuf type google.cloud.aiplatform.v1beta1.ExecuteExtensionRequest

Static Fields

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

OPERATION_ID_FIELD_NUMBER

public static final int OPERATION_ID_FIELD_NUMBER
Field Value
Type Description
int

OPERATION_PARAMS_FIELD_NUMBER

public static final int OPERATION_PARAMS_FIELD_NUMBER
Field Value
Type Description
int

RUNTIME_AUTH_CONFIG_FIELD_NUMBER

public static final int RUNTIME_AUTH_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExecuteExtensionRequest getDefaultInstance()
Returns
Type Description
ExecuteExtensionRequest

getDescriptor()

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

newBuilder()

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

newBuilder(ExecuteExtensionRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ExecuteExtensionRequest getDefaultInstanceForType()
Returns
Type Description
ExecuteExtensionRequest

getName()

public String getName()

Required. Name (identifier) of the extension; Format: projects/{project}/locations/{location}/extensions/{extension}

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. Name (identifier) of the extension; Format: projects/{project}/locations/{location}/extensions/{extension}

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

Returns
Type Description
ByteString

The bytes for name.

getOperationId()

public String getOperationId()

Required. The desired ID of the operation to be executed in this extension as defined in ExtensionOperation.operation_id.

string operation_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The operationId.

getOperationIdBytes()

public ByteString getOperationIdBytes()

Required. The desired ID of the operation to be executed in this extension as defined in ExtensionOperation.operation_id.

string operation_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for operationId.

getOperationParams()

public Struct getOperationParams()

Optional. Request parameters that will be used for executing this operation.

The struct should be in a form of map with param name as the key and actual param value as the value. E.g. If this operation requires a param "name" to be set to "abc". you can set this to something like {"name": "abc"}.

.google.protobuf.Struct operation_params = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Struct

The operationParams.

getOperationParamsOrBuilder()

public StructOrBuilder getOperationParamsOrBuilder()

Optional. Request parameters that will be used for executing this operation.

The struct should be in a form of map with param name as the key and actual param value as the value. E.g. If this operation requires a param "name" to be set to "abc". you can set this to something like {"name": "abc"}.

.google.protobuf.Struct operation_params = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StructOrBuilder

getParserForType()

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

getRuntimeAuthConfig()

public AuthConfig getRuntimeAuthConfig()

Optional. Auth config provided at runtime to override the default value in [Extension.manifest.auth_config][]. The AuthConfig.auth_type should match the value in [Extension.manifest.auth_config][].

.google.cloud.aiplatform.v1beta1.AuthConfig runtime_auth_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AuthConfig

The runtimeAuthConfig.

getRuntimeAuthConfigOrBuilder()

public AuthConfigOrBuilder getRuntimeAuthConfigOrBuilder()

Optional. Auth config provided at runtime to override the default value in [Extension.manifest.auth_config][]. The AuthConfig.auth_type should match the value in [Extension.manifest.auth_config][].

.google.cloud.aiplatform.v1beta1.AuthConfig runtime_auth_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AuthConfigOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasOperationParams()

public boolean hasOperationParams()

Optional. Request parameters that will be used for executing this operation.

The struct should be in a form of map with param name as the key and actual param value as the value. E.g. If this operation requires a param "name" to be set to "abc". you can set this to something like {"name": "abc"}.

.google.protobuf.Struct operation_params = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the operationParams field is set.

hasRuntimeAuthConfig()

public boolean hasRuntimeAuthConfig()

Optional. Auth config provided at runtime to override the default value in [Extension.manifest.auth_config][]. The AuthConfig.auth_type should match the value in [Extension.manifest.auth_config][].

.google.cloud.aiplatform.v1beta1.AuthConfig runtime_auth_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the runtimeAuthConfig 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 ExecuteExtensionRequest.Builder newBuilderForType()
Returns
Type Description
ExecuteExtensionRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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