Class Endpoint (1.12.0)

publicfinalclass EndpointextendsGeneratedMessageV3implementsEndpointOrBuilder

Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations.

Protobuf type google.cloud.vertexai.v1.Endpoint

Inheritance

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

Implements

EndpointOrBuilder

Inherited Members

publicstaticfinalintCREATE_TIME_FIELD_NUMBER

publicstaticfinalintDEDICATED_ENDPOINT_DNS_FIELD_NUMBER

publicstaticfinalintDEDICATED_ENDPOINT_ENABLED_FIELD_NUMBER

publicstaticfinalintDEPLOYED_MODELS_FIELD_NUMBER

publicstaticfinalintDESCRIPTION_FIELD_NUMBER

publicstaticfinalintDISPLAY_NAME_FIELD_NUMBER

publicstaticfinalintENABLE_PRIVATE_SERVICE_CONNECT_FIELD_NUMBER

publicstaticfinalintENCRYPTION_SPEC_FIELD_NUMBER

publicstaticfinalintETAG_FIELD_NUMBER

publicstaticfinalintLABELS_FIELD_NUMBER

publicstaticfinalintMODEL_DEPLOYMENT_MONITORING_JOB_FIELD_NUMBER

publicstaticfinalintNAME_FIELD_NUMBER

publicstaticfinalintNETWORK_FIELD_NUMBER

publicstaticfinalintPREDICT_REQUEST_RESPONSE_LOGGING_CONFIG_FIELD_NUMBER

publicstaticfinalintPRIVATE_SERVICE_CONNECT_CONFIG_FIELD_NUMBER

publicstaticfinalintSATISFIES_PZI_FIELD_NUMBER

publicstaticfinalintSATISFIES_PZS_FIELD_NUMBER

publicstaticfinalintTRAFFIC_SPLIT_FIELD_NUMBER

publicstaticfinalintUPDATE_TIME_FIELD_NUMBER

publicstaticEndpointgetDefaultInstance()

publicstaticfinalDescriptors.DescriptorgetDescriptor()

publicstaticEndpoint.BuildernewBuilder()

publicstaticEndpoint.BuildernewBuilder(Endpointprototype)

publicstaticEndpointparseDelimitedFrom(InputStreaminput)

publicstaticEndpointparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticEndpointparseFrom(byte[]data)

publicstaticEndpointparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)

publicstaticEndpointparseFrom(ByteStringdata)

publicstaticEndpointparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)

publicstaticEndpointparseFrom(CodedInputStreaminput)

publicstaticEndpointparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticEndpointparseFrom(InputStreaminput)

publicstaticEndpointparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticEndpointparseFrom(ByteBufferdata)

publicstaticEndpointparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)

publicstaticParser<Endpoint>parser()

publicbooleancontainsLabels(Stringkey)

The labels with user-defined metadata to organize your Endpoints.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

map<string, string> labels = 7;

publicbooleancontainsTrafficSplit(Stringkey)

A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel.

If a DeployedModel's ID is not listed in this map, then it receives no traffic.

The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment.

map<string, int32> traffic_split = 5;

publicbooleanequals(Objectobj)

AbstractMessage.equals(Object other)

publicTimestampgetCreateTime()

Output only. Timestamp when this Endpoint was created.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

publicTimestampOrBuildergetCreateTimeOrBuilder()

Output only. Timestamp when this Endpoint was created.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

publicStringgetDedicatedEndpointDns()

Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog.

string dedicated_endpoint_dns = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

publicByteStringgetDedicatedEndpointDnsBytes()

Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog.

string dedicated_endpoint_dns = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

publicbooleangetDedicatedEndpointEnabled()

If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon.

bool dedicated_endpoint_enabled = 24;

publicEndpointgetDefaultInstanceForType()

publicDeployedModelgetDeployedModels(intindex)

Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.

repeated .google.cloud.vertexai.v1.DeployedModel deployed_models = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

publicintgetDeployedModelsCount()

Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.

repeated .google.cloud.vertexai.v1.DeployedModel deployed_models = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

publicList<DeployedModel>getDeployedModelsList()

Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.

repeated .google.cloud.vertexai.v1.DeployedModel deployed_models = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

publicDeployedModelOrBuildergetDeployedModelsOrBuilder(intindex)

Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.

repeated .google.cloud.vertexai.v1.DeployedModel deployed_models = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

publicList<?extendsDeployedModelOrBuilder>getDeployedModelsOrBuilderList()

Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.

repeated .google.cloud.vertexai.v1.DeployedModel deployed_models = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

publicStringgetDescription()

The description of the Endpoint.

string description = 3;

publicByteStringgetDescriptionBytes()

The description of the Endpoint.

string description = 3;

publicStringgetDisplayName()

Required. The display name of the Endpoint. The name can be up to 128 characters long and can consist of any UTF-8 characters.

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

publicByteStringgetDisplayNameBytes()

Required. The display name of the Endpoint. The name can be up to 128 characters long and can consist of any UTF-8 characters.

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

publicbooleangetEnablePrivateServiceConnect()

Deprecated. google.cloud.vertexai.v1.Endpoint.enable_private_service_connect is deprecated. See google/cloud/vertexai/v1/endpoint.proto;l=127

Deprecated: If true, expose the Endpoint via private service connect.

Only one of the fields, network or enable_private_service_connect, can be set.

bool enable_private_service_connect = 17 [deprecated = true];

publicEncryptionSpecgetEncryptionSpec()

Customer-managed encryption key spec for an Endpoint. If set, this Endpoint and all sub-resources of this Endpoint will be secured by this key.

.google.cloud.vertexai.v1.EncryptionSpec encryption_spec = 10;

publicEncryptionSpecOrBuildergetEncryptionSpecOrBuilder()

Customer-managed encryption key spec for an Endpoint. If set, this Endpoint and all sub-resources of this Endpoint will be secured by this key.

.google.cloud.vertexai.v1.EncryptionSpec encryption_spec = 10;

publicStringgetEtag()

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

string etag = 6;

publicByteStringgetEtagBytes()

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

string etag = 6;

publicMap<String,String>getLabels()

Use #getLabelsMap() instead.

publicintgetLabelsCount()

The labels with user-defined metadata to organize your Endpoints.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

map<string, string> labels = 7;

publicMap<String,String>getLabelsMap()

The labels with user-defined metadata to organize your Endpoints.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

map<string, string> labels = 7;

publicStringgetLabelsOrDefault(Stringkey,StringdefaultValue)

The labels with user-defined metadata to organize your Endpoints.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

map<string, string> labels = 7;

publicStringgetLabelsOrThrow(Stringkey)

The labels with user-defined metadata to organize your Endpoints.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

map<string, string> labels = 7;

publicStringgetModelDeploymentMonitoringJob()

Output only. Resource name of the Model Monitoring job associated with this Endpoint if monitoring is enabled by JobService.CreateModelDeploymentMonitoringJob. Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

string model_deployment_monitoring_job = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

publicByteStringgetModelDeploymentMonitoringJobBytes()

Output only. Resource name of the Model Monitoring job associated with this Endpoint if monitoring is enabled by JobService.CreateModelDeploymentMonitoringJob. Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

string model_deployment_monitoring_job = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

publicStringgetName()

Output only. The resource name of the Endpoint.

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

publicByteStringgetNameBytes()

Output only. The resource name of the Endpoint.

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

publicStringgetNetwork()

Optional. The full name of the Google Compute Engine network to which the Endpoint should be peered.

Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network.

Only one of the fields, network or enable_private_service_connect, can be set.

Format: projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is network name.

string network = 13 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

publicByteStringgetNetworkBytes()

Optional. The full name of the Google Compute Engine network to which the Endpoint should be peered.

Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network.

Only one of the fields, network or enable_private_service_connect, can be set.

Format: projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is network name.

string network = 13 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

publicParser<Endpoint>getParserForType()

GeneratedMessageV3.getParserForType()

publicPredictRequestResponseLoggingConfiggetPredictRequestResponseLoggingConfig()

Configures the request-response logging for online prediction.

.google.cloud.vertexai.v1.PredictRequestResponseLoggingConfig predict_request_response_logging_config = 18;

publicPredictRequestResponseLoggingConfigOrBuildergetPredictRequestResponseLoggingConfigOrBuilder()

Configures the request-response logging for online prediction.

.google.cloud.vertexai.v1.PredictRequestResponseLoggingConfig predict_request_response_logging_config = 18;

publicPrivateServiceConnectConfiggetPrivateServiceConnectConfig()

Optional. Configuration for private service connect.

network and private_service_connect_config are mutually exclusive.

.google.cloud.vertexai.v1.PrivateServiceConnectConfig private_service_connect_config = 21 [(.google.api.field_behavior) = OPTIONAL];

publicPrivateServiceConnectConfigOrBuildergetPrivateServiceConnectConfigOrBuilder()

Optional. Configuration for private service connect.

network and private_service_connect_config are mutually exclusive.

.google.cloud.vertexai.v1.PrivateServiceConnectConfig private_service_connect_config = 21 [(.google.api.field_behavior) = OPTIONAL];

publicbooleangetSatisfiesPzi()

Output only. Reserved for future use.

bool satisfies_pzi = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

publicbooleangetSatisfiesPzs()

Output only. Reserved for future use.

bool satisfies_pzs = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

publicintgetSerializedSize()

GeneratedMessageV3.getSerializedSize()

publicMap<String,Integer>getTrafficSplit()

Use #getTrafficSplitMap() instead.

publicintgetTrafficSplitCount()

A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel.

If a DeployedModel's ID is not listed in this map, then it receives no traffic.

The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment.

map<string, int32> traffic_split = 5;

publicMap<String,Integer>getTrafficSplitMap()

A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel.

If a DeployedModel's ID is not listed in this map, then it receives no traffic.

The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment.

map<string, int32> traffic_split = 5;

publicintgetTrafficSplitOrDefault(Stringkey,intdefaultValue)

A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel.

If a DeployedModel's ID is not listed in this map, then it receives no traffic.

The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment.

map<string, int32> traffic_split = 5;

publicintgetTrafficSplitOrThrow(Stringkey)

A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel.

If a DeployedModel's ID is not listed in this map, then it receives no traffic.

The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment.

map<string, int32> traffic_split = 5;

publicTimestampgetUpdateTime()

Output only. Timestamp when this Endpoint was last updated.

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

publicTimestampOrBuildergetUpdateTimeOrBuilder()

Output only. Timestamp when this Endpoint was last updated.

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

publicbooleanhasCreateTime()

Output only. Timestamp when this Endpoint was created.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

publicbooleanhasEncryptionSpec()

Customer-managed encryption key spec for an Endpoint. If set, this Endpoint and all sub-resources of this Endpoint will be secured by this key.

.google.cloud.vertexai.v1.EncryptionSpec encryption_spec = 10;

publicbooleanhasPredictRequestResponseLoggingConfig()

Configures the request-response logging for online prediction.

.google.cloud.vertexai.v1.PredictRequestResponseLoggingConfig predict_request_response_logging_config = 18;

publicbooleanhasPrivateServiceConnectConfig()

Optional. Configuration for private service connect.

network and private_service_connect_config are mutually exclusive.

.google.cloud.vertexai.v1.PrivateServiceConnectConfig private_service_connect_config = 21 [(.google.api.field_behavior) = OPTIONAL];

publicbooleanhasUpdateTime()

Output only. Timestamp when this Endpoint was last updated.

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

publicinthashCode()

AbstractMessage.hashCode()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()

GeneratedMessageV3.internalGetFieldAccessorTable()

protectedMapFieldReflectionAccessorinternalGetMapFieldReflection(intnumber)

publicfinalbooleanisInitialized()

GeneratedMessageV3.isInitialized()

publicEndpoint.BuildernewBuilderForType()

protectedEndpoint.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

publicEndpoint.BuildertoBuilder()

publicvoidwriteTo(CodedOutputStreamoutput)

GeneratedMessageV3.writeTo(CodedOutputStream output)