Class ExecuteExtensionRequest.Builder (3.46.0)

public static final class ExecuteExtensionRequest.Builder extends GeneratedMessageV3.Builder<ExecuteExtensionRequest.Builder> implements ExecuteExtensionRequestOrBuilder

Request message for ExtensionExecutionService.ExecuteExtension.

Protobuf type google.cloud.aiplatform.v1beta1.ExecuteExtensionRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ExecuteExtensionRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ExecuteExtensionRequest.Builder
Overrides

build()

public ExecuteExtensionRequest build()
Returns
Type Description
ExecuteExtensionRequest

buildPartial()

public ExecuteExtensionRequest buildPartial()
Returns
Type Description
ExecuteExtensionRequest

clear()

public ExecuteExtensionRequest.Builder clear()
Returns
Type Description
ExecuteExtensionRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ExecuteExtensionRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ExecuteExtensionRequest.Builder
Overrides

clearName()

public ExecuteExtensionRequest.Builder clearName()

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
ExecuteExtensionRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ExecuteExtensionRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ExecuteExtensionRequest.Builder
Overrides

clearOperationId()

public ExecuteExtensionRequest.Builder clearOperationId()

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
ExecuteExtensionRequest.Builder

This builder for chaining.

clearOperationParams()

public ExecuteExtensionRequest.Builder clearOperationParams()

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
ExecuteExtensionRequest.Builder

clearRuntimeAuthConfig()

public ExecuteExtensionRequest.Builder clearRuntimeAuthConfig()

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
ExecuteExtensionRequest.Builder

clone()

public ExecuteExtensionRequest.Builder clone()
Returns
Type Description
ExecuteExtensionRequest.Builder
Overrides

getDefaultInstanceForType()

public ExecuteExtensionRequest getDefaultInstanceForType()
Returns
Type Description
ExecuteExtensionRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getOperationParamsBuilder()

public Struct.Builder getOperationParamsBuilder()

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
Builder

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

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.

getRuntimeAuthConfigBuilder()

public AuthConfig.Builder getRuntimeAuthConfigBuilder()

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.Builder

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

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ExecuteExtensionRequest other)

public ExecuteExtensionRequest.Builder mergeFrom(ExecuteExtensionRequest other)
Parameter
Name Description
other ExecuteExtensionRequest
Returns
Type Description
ExecuteExtensionRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ExecuteExtensionRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteExtensionRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ExecuteExtensionRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ExecuteExtensionRequest.Builder
Overrides

mergeOperationParams(Struct value)

public ExecuteExtensionRequest.Builder mergeOperationParams(Struct value)

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];

Parameter
Name Description
value Struct
Returns
Type Description
ExecuteExtensionRequest.Builder

mergeRuntimeAuthConfig(AuthConfig value)

public ExecuteExtensionRequest.Builder mergeRuntimeAuthConfig(AuthConfig value)

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];

Parameter
Name Description
value AuthConfig
Returns
Type Description
ExecuteExtensionRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ExecuteExtensionRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ExecuteExtensionRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ExecuteExtensionRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ExecuteExtensionRequest.Builder
Overrides

setName(String value)

public ExecuteExtensionRequest.Builder setName(String value)

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) = { ... }

Parameter
Name Description
value String

The name to set.

Returns
Type Description
ExecuteExtensionRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ExecuteExtensionRequest.Builder setNameBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
ExecuteExtensionRequest.Builder

This builder for chaining.

setOperationId(String value)

public ExecuteExtensionRequest.Builder setOperationId(String value)

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];

Parameter
Name Description
value String

The operationId to set.

Returns
Type Description
ExecuteExtensionRequest.Builder

This builder for chaining.

setOperationIdBytes(ByteString value)

public ExecuteExtensionRequest.Builder setOperationIdBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for operationId to set.

Returns
Type Description
ExecuteExtensionRequest.Builder

This builder for chaining.

setOperationParams(Struct value)

public ExecuteExtensionRequest.Builder setOperationParams(Struct value)

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];

Parameter
Name Description
value Struct
Returns
Type Description
ExecuteExtensionRequest.Builder

setOperationParams(Struct.Builder builderForValue)

public ExecuteExtensionRequest.Builder setOperationParams(Struct.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ExecuteExtensionRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ExecuteExtensionRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ExecuteExtensionRequest.Builder
Overrides

setRuntimeAuthConfig(AuthConfig value)

public ExecuteExtensionRequest.Builder setRuntimeAuthConfig(AuthConfig value)

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];

Parameter
Name Description
value AuthConfig
Returns
Type Description
ExecuteExtensionRequest.Builder

setRuntimeAuthConfig(AuthConfig.Builder builderForValue)

public ExecuteExtensionRequest.Builder setRuntimeAuthConfig(AuthConfig.Builder builderForValue)

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];

Parameter
Name Description
builderForValue AuthConfig.Builder
Returns
Type Description
ExecuteExtensionRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ExecuteExtensionRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ExecuteExtensionRequest.Builder
Overrides