- 3.19.0 (latest)
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.0
- 3.3.0
- 3.2.0
- 3.1.0
- 3.0.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.0
- 2.2.0
- 2.1.0
- 2.0.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
public abstract class EndpointServiceClient
EndpointService client wrapper, for convenient use.
Derived Types
Namespace
Google.Cloud.AIPlatform.V1Assembly
Google.Cloud.AIPlatform.V1.dll
Remarks
A service for managing Vertex AI's Endpoints.
Properties
CreateEndpointOperationsClient
public virtual OperationsClient CreateEndpointOperationsClient { get; }
The long-running operations client for CreateEndpoint
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DefaultEndpoint
public static string DefaultEndpoint { get; }
The default endpoint for the EndpointService service, which is a host of "aiplatform.googleapis.com" and a port of 443.
Property Value | |
---|---|
Type | Description |
String |
DefaultScopes
public static IReadOnlyList<string> DefaultScopes { get; }
The default EndpointService scopes.
Property Value | |
---|---|
Type | Description |
IReadOnlyList<String> |
The default EndpointService scopes are:
DeleteEndpointOperationsClient
public virtual OperationsClient DeleteEndpointOperationsClient { get; }
The long-running operations client for DeleteEndpoint
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeployModelOperationsClient
public virtual OperationsClient DeployModelOperationsClient { get; }
The long-running operations client for DeployModel
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
GrpcClient
public virtual EndpointService.EndpointServiceClient GrpcClient { get; }
The underlying gRPC EndpointService client
Property Value | |
---|---|
Type | Description |
EndpointService.EndpointServiceClient |
IAMPolicyClient
public virtual IAMPolicyClient IAMPolicyClient { get; }
The IAMPolicyClient associated with this client.
Property Value | |
---|---|
Type | Description |
IAMPolicyClient |
LocationsClient
public virtual LocationsClient LocationsClient { get; }
The LocationsClient associated with this client.
Property Value | |
---|---|
Type | Description |
LocationsClient |
ServiceMetadata
public static ServiceMetadata ServiceMetadata { get; }
The service metadata associated with this client type.
Property Value | |
---|---|
Type | Description |
ServiceMetadata |
UndeployModelOperationsClient
public virtual OperationsClient UndeployModelOperationsClient { get; }
The long-running operations client for UndeployModel
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
Methods
Create()
public static EndpointServiceClient Create()
Synchronously creates a EndpointServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use EndpointServiceClientBuilder.
Returns | |
---|---|
Type | Description |
EndpointServiceClient | The created EndpointServiceClient. |
CreateAsync(CancellationToken)
public static Task<EndpointServiceClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))
Asynchronously creates a EndpointServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use EndpointServiceClientBuilder.
Parameter | |
---|---|
Name | Description |
cancellationToken | CancellationToken The CancellationToken to use while creating the client. |
Returns | |
---|---|
Type | Description |
Task<EndpointServiceClient> | The task representing the created EndpointServiceClient. |
CreateEndpoint(LocationName, Endpoint, CallSettings)
public virtual Operation<Endpoint, CreateEndpointOperationMetadata> CreateEndpoint(LocationName parent, Endpoint endpoint, CallSettings callSettings = null)
Creates an Endpoint.
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. The resource name of the Location to create the Endpoint in.
Format: |
endpoint | Endpoint Required. The Endpoint to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Endpoint, CreateEndpointOperationMetadata> | The RPC response. |
// Create client
EndpointServiceClient endpointServiceClient = EndpointServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Endpoint endpoint = new Endpoint();
// Make the request
Operation<Endpoint, CreateEndpointOperationMetadata> response = endpointServiceClient.CreateEndpoint(parent, endpoint);
// Poll until the returned long-running operation is complete
Operation<Endpoint, CreateEndpointOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Endpoint result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Endpoint, CreateEndpointOperationMetadata> retrievedResponse = endpointServiceClient.PollOnceCreateEndpoint(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Endpoint retrievedResult = retrievedResponse.Result;
}
CreateEndpoint(LocationName, Endpoint, String, CallSettings)
public virtual Operation<Endpoint, CreateEndpointOperationMetadata> CreateEndpoint(LocationName parent, Endpoint endpoint, string endpointId, CallSettings callSettings = null)
Creates an Endpoint.
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. The resource name of the Location to create the Endpoint in.
Format: |
endpoint | Endpoint Required. The Endpoint to create. |
endpointId | String Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. This value should be 1-10 characters, and valid characters are /[0-9]/.
When using HTTP/JSON, this field is populated based on a query string
argument, such as |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Endpoint, CreateEndpointOperationMetadata> | The RPC response. |
// Create client
EndpointServiceClient endpointServiceClient = EndpointServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Endpoint endpoint = new Endpoint();
string endpointId = "";
// Make the request
Operation<Endpoint, CreateEndpointOperationMetadata> response = endpointServiceClient.CreateEndpoint(parent, endpoint, endpointId);
// Poll until the returned long-running operation is complete
Operation<Endpoint, CreateEndpointOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Endpoint result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Endpoint, CreateEndpointOperationMetadata> retrievedResponse = endpointServiceClient.PollOnceCreateEndpoint(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Endpoint retrievedResult = retrievedResponse.Result;
}
CreateEndpoint(CreateEndpointRequest, CallSettings)
public virtual Operation<Endpoint, CreateEndpointOperationMetadata> CreateEndpoint(CreateEndpointRequest request, CallSettings callSettings = null)
Creates an Endpoint.
Parameters | |
---|---|
Name | Description |
request | CreateEndpointRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Endpoint, CreateEndpointOperationMetadata> | The RPC response. |
// Create client
EndpointServiceClient endpointServiceClient = EndpointServiceClient.Create();
// Initialize request argument(s)
CreateEndpointRequest request = new CreateEndpointRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
Endpoint = new Endpoint(),
EndpointId = "",
};
// Make the request
Operation<Endpoint, CreateEndpointOperationMetadata> response = endpointServiceClient.CreateEndpoint(request);
// Poll until the returned long-running operation is complete
Operation<Endpoint, CreateEndpointOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Endpoint result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Endpoint, CreateEndpointOperationMetadata> retrievedResponse = endpointServiceClient.PollOnceCreateEndpoint(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Endpoint retrievedResult = retrievedResponse.Result;
}
CreateEndpoint(String, Endpoint, CallSettings)
public virtual Operation<Endpoint, CreateEndpointOperationMetadata> CreateEndpoint(string parent, Endpoint endpoint, CallSettings callSettings = null)
Creates an Endpoint.
Parameters | |
---|---|
Name | Description |
parent | String Required. The resource name of the Location to create the Endpoint in.
Format: |
endpoint | Endpoint Required. The Endpoint to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Endpoint, CreateEndpointOperationMetadata> | The RPC response. |
// Create client
EndpointServiceClient endpointServiceClient = EndpointServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Endpoint endpoint = new Endpoint();
// Make the request
Operation<Endpoint, CreateEndpointOperationMetadata> response = endpointServiceClient.CreateEndpoint(parent, endpoint);
// Poll until the returned long-running operation is complete
Operation<Endpoint, CreateEndpointOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Endpoint result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Endpoint, CreateEndpointOperationMetadata> retrievedResponse = endpointServiceClient.PollOnceCreateEndpoint(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Endpoint retrievedResult = retrievedResponse.Result;
}
CreateEndpoint(String, Endpoint, String, CallSettings)
public virtual Operation<Endpoint, CreateEndpointOperationMetadata> CreateEndpoint(string parent, Endpoint endpoint, string endpointId, CallSettings callSettings = null)
Creates an Endpoint.
Parameters | |
---|---|
Name | Description |
parent | String Required. The resource name of the Location to create the Endpoint in.
Format: |
endpoint | Endpoint Required. The Endpoint to create. |
endpointId | String Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. This value should be 1-10 characters, and valid characters are /[0-9]/.
When using HTTP/JSON, this field is populated based on a query string
argument, such as |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Endpoint, CreateEndpointOperationMetadata> | The RPC response. |
// Create client
EndpointServiceClient endpointServiceClient = EndpointServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Endpoint endpoint = new Endpoint();
string endpointId = "";
// Make the request
Operation<Endpoint, CreateEndpointOperationMetadata> response = endpointServiceClient.CreateEndpoint(parent, endpoint, endpointId);
// Poll until the returned long-running operation is complete
Operation<Endpoint, CreateEndpointOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Endpoint result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Endpoint, CreateEndpointOperationMetadata> retrievedResponse = endpointServiceClient.PollOnceCreateEndpoint(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Endpoint retrievedResult = retrievedResponse.Result;
}
CreateEndpointAsync(LocationName, Endpoint, CallSettings)
public virtual Task<Operation<Endpoint, CreateEndpointOperationMetadata>> CreateEndpointAsync(LocationName parent, Endpoint endpoint, CallSettings callSettings = null)
Creates an Endpoint.
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. The resource name of the Location to create the Endpoint in.
Format: |
endpoint | Endpoint Required. The Endpoint to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Endpoint, CreateEndpointOperationMetadata>> | A Task containing the RPC response. |
// Create client
EndpointServiceClient endpointServiceClient = await EndpointServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Endpoint endpoint = new Endpoint();
// Make the request
Operation<Endpoint, CreateEndpointOperationMetadata> response = await endpointServiceClient.CreateEndpointAsync(parent, endpoint);
// Poll until the returned long-running operation is complete
Operation<Endpoint, CreateEndpointOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Endpoint result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Endpoint, CreateEndpointOperationMetadata> retrievedResponse = await endpointServiceClient.PollOnceCreateEndpointAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Endpoint retrievedResult = retrievedResponse.Result;
}
CreateEndpointAsync(LocationName, Endpoint, String, CallSettings)
public virtual Task<Operation<Endpoint, CreateEndpointOperationMetadata>> CreateEndpointAsync(LocationName parent, Endpoint endpoint, string endpointId, CallSettings callSettings = null)
Creates an Endpoint.
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. The resource name of the Location to create the Endpoint in.
Format: |
endpoint | Endpoint Required. The Endpoint to create. |
endpointId | String Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. This value should be 1-10 characters, and valid characters are /[0-9]/.
When using HTTP/JSON, this field is populated based on a query string
argument, such as |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Endpoint, CreateEndpointOperationMetadata>> | A Task containing the RPC response. |
// Create client
EndpointServiceClient endpointServiceClient = await EndpointServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Endpoint endpoint = new Endpoint();
string endpointId = "";
// Make the request
Operation<Endpoint, CreateEndpointOperationMetadata> response = await endpointServiceClient.CreateEndpointAsync(parent, endpoint, endpointId);
// Poll until the returned long-running operation is complete
Operation<Endpoint, CreateEndpointOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Endpoint result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Endpoint, CreateEndpointOperationMetadata> retrievedResponse = await endpointServiceClient.PollOnceCreateEndpointAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Endpoint retrievedResult = retrievedResponse.Result;
}
CreateEndpointAsync(LocationName, Endpoint, String, CancellationToken)
public virtual Task<Operation<Endpoint, CreateEndpointOperationMetadata>> CreateEndpointAsync(LocationName parent, Endpoint endpoint, string endpointId, CancellationToken cancellationToken)
Creates an Endpoint.
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. The resource name of the Location to create the Endpoint in.
Format: |
endpoint | Endpoint Required. The Endpoint to create. |
endpointId | String Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. This value should be 1-10 characters, and valid characters are /[0-9]/.
When using HTTP/JSON, this field is populated based on a query string
argument, such as |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Endpoint, CreateEndpointOperationMetadata>> | A Task containing the RPC response. |
// Create client
EndpointServiceClient endpointServiceClient = await EndpointServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Endpoint endpoint = new Endpoint();
string endpointId = "";
// Make the request
Operation<Endpoint, CreateEndpointOperationMetadata> response = await endpointServiceClient.CreateEndpointAsync(parent, endpoint, endpointId);
// Poll until the returned long-running operation is complete
Operation<Endpoint, CreateEndpointOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Endpoint result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Endpoint, CreateEndpointOperationMetadata> retrievedResponse = await endpointServiceClient.PollOnceCreateEndpointAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Endpoint retrievedResult = retrievedResponse.Result;
}
CreateEndpointAsync(LocationName, Endpoint, CancellationToken)
public virtual Task<Operation<Endpoint, CreateEndpointOperationMetadata>> CreateEndpointAsync(LocationName parent, Endpoint endpoint, CancellationToken cancellationToken)
Creates an Endpoint.
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. The resource name of the Location to create the Endpoint in.
Format: |
endpoint | Endpoint Required. The Endpoint to create. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Endpoint, CreateEndpointOperationMetadata>> | A Task containing the RPC response. |
// Create client
EndpointServiceClient endpointServiceClient = await EndpointServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Endpoint endpoint = new Endpoint();
// Make the request
Operation<Endpoint, CreateEndpointOperationMetadata> response = await endpointServiceClient.CreateEndpointAsync(parent, endpoint);
// Poll until the returned long-running operation is complete
Operation<Endpoint, CreateEndpointOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Endpoint result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Endpoint, CreateEndpointOperationMetadata> retrievedResponse = await endpointServiceClient.PollOnceCreateEndpointAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Endpoint retrievedResult = retrievedResponse.Result;
}
CreateEndpointAsync(CreateEndpointRequest, CallSettings)
public virtual Task<Operation<Endpoint, CreateEndpointOperationMetadata>> CreateEndpointAsync(CreateEndpointRequest request, CallSettings callSettings = null)
Creates an Endpoint.
Parameters | |
---|---|
Name | Description |
request | CreateEndpointRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Endpoint, CreateEndpointOperationMetadata>> | A Task containing the RPC response. |
// Create client
EndpointServiceClient endpointServiceClient = await EndpointServiceClient.CreateAsync();
// Initialize request argument(s)
CreateEndpointRequest request = new CreateEndpointRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
Endpoint = new Endpoint(),
EndpointId = "",
};
// Make the request
Operation<Endpoint, CreateEndpointOperationMetadata> response = await endpointServiceClient.CreateEndpointAsync(request);
// Poll until the returned long-running operation is complete
Operation<Endpoint, CreateEndpointOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Endpoint result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Endpoint, CreateEndpointOperationMetadata> retrievedResponse = await endpointServiceClient.PollOnceCreateEndpointAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Endpoint retrievedResult = retrievedResponse.Result;
}
CreateEndpointAsync(CreateEndpointRequest, CancellationToken)
public virtual Task<Operation<Endpoint, CreateEndpointOperationMetadata>> CreateEndpointAsync(CreateEndpointRequest request, CancellationToken cancellationToken)
Creates an Endpoint.
Parameters | |
---|---|
Name | Description |
request | CreateEndpointRequest The request object containing all of the parameters for the API call. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Endpoint, CreateEndpointOperationMetadata>> | A Task containing the RPC response. |
// Create client
EndpointServiceClient endpointServiceClient = await EndpointServiceClient.CreateAsync();
// Initialize request argument(s)
CreateEndpointRequest request = new CreateEndpointRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
Endpoint = new Endpoint(),
EndpointId = "",
};
// Make the request
Operation<Endpoint, CreateEndpointOperationMetadata> response = await endpointServiceClient.CreateEndpointAsync(request);
// Poll until the returned long-running operation is complete
Operation<Endpoint, CreateEndpointOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Endpoint result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Endpoint, CreateEndpointOperationMetadata> retrievedResponse = await endpointServiceClient.PollOnceCreateEndpointAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Endpoint retrievedResult = retrievedResponse.Result;
}
CreateEndpointAsync(String, Endpoint, CallSettings)
public virtual Task<Operation<Endpoint, CreateEndpointOperationMetadata>> CreateEndpointAsync(string parent, Endpoint endpoint, CallSettings callSettings = null)
Creates an Endpoint.
Parameters | |
---|---|
Name | Description |
parent | String Required. The resource name of the Location to create the Endpoint in.
Format: |
endpoint | Endpoint Required. The Endpoint to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Endpoint, CreateEndpointOperationMetadata>> | A Task containing the RPC response. |
// Create client
EndpointServiceClient endpointServiceClient = await EndpointServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Endpoint endpoint = new Endpoint();
// Make the request
Operation<Endpoint, CreateEndpointOperationMetadata> response = await endpointServiceClient.CreateEndpointAsync(parent, endpoint);
// Poll until the returned long-running operation is complete
Operation<Endpoint, CreateEndpointOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Endpoint result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Endpoint, CreateEndpointOperationMetadata> retrievedResponse = await endpointServiceClient.PollOnceCreateEndpointAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Endpoint retrievedResult = retrievedResponse.Result;
}
CreateEndpointAsync(String, Endpoint, String, CallSettings)
public virtual Task<Operation<Endpoint, CreateEndpointOperationMetadata>> CreateEndpointAsync(string parent, Endpoint endpoint, string endpointId, CallSettings callSettings = null)
Creates an Endpoint.
Parameters | |
---|---|
Name | Description |
parent | String Required. The resource name of the Location to create the Endpoint in.
Format: |
endpoint | Endpoint Required. The Endpoint to create. |
endpointId | String Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. This value should be 1-10 characters, and valid characters are /[0-9]/.
When using HTTP/JSON, this field is populated based on a query string
argument, such as |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Endpoint, CreateEndpointOperationMetadata>> | A Task containing the RPC response. |
// Create client
EndpointServiceClient endpointServiceClient = await EndpointServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Endpoint endpoint = new Endpoint();
string endpointId = "";
// Make the request
Operation<Endpoint, CreateEndpointOperationMetadata> response = await endpointServiceClient.CreateEndpointAsync(parent, endpoint, endpointId);
// Poll until the returned long-running operation is complete
Operation<Endpoint, CreateEndpointOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Endpoint result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Endpoint, CreateEndpointOperationMetadata> retrievedResponse = await endpointServiceClient.PollOnceCreateEndpointAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Endpoint retrievedResult = retrievedResponse.Result;
}
CreateEndpointAsync(String, Endpoint, String, CancellationToken)
public virtual Task<Operation<Endpoint, CreateEndpointOperationMetadata>> CreateEndpointAsync(string parent, Endpoint endpoint, string endpointId, CancellationToken cancellationToken)
Creates an Endpoint.
Parameters | |
---|---|
Name | Description |
parent | String Required. The resource name of the Location to create the Endpoint in.
Format: |
endpoint | Endpoint Required. The Endpoint to create. |
endpointId | String Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. This value should be 1-10 characters, and valid characters are /[0-9]/.
When using HTTP/JSON, this field is populated based on a query string
argument, such as |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Endpoint, CreateEndpointOperationMetadata>> | A Task containing the RPC response. |
// Create client
EndpointServiceClient endpointServiceClient = await EndpointServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Endpoint endpoint = new Endpoint();
string endpointId = "";
// Make the request
Operation<Endpoint, CreateEndpointOperationMetadata> response = await endpointServiceClient.CreateEndpointAsync(parent, endpoint, endpointId);
// Poll until the returned long-running operation is complete
Operation<Endpoint, CreateEndpointOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Endpoint result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Endpoint, CreateEndpointOperationMetadata> retrievedResponse = await endpointServiceClient.PollOnceCreateEndpointAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Endpoint retrievedResult = retrievedResponse.Result;
}
CreateEndpointAsync(String, Endpoint, CancellationToken)
public virtual Task<Operation<Endpoint, CreateEndpointOperationMetadata>> CreateEndpointAsync(string parent, Endpoint endpoint, CancellationToken cancellationToken)
Creates an Endpoint.
Parameters | |
---|---|
Name | Description |
parent | String Required. The resource name of the Location to create the Endpoint in.
Format: |
endpoint | Endpoint Required. The Endpoint to create. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Endpoint, CreateEndpointOperationMetadata>> | A Task containing the RPC response. |
// Create client
EndpointServiceClient endpointServiceClient = await EndpointServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Endpoint endpoint = new Endpoint();
// Make the request
Operation<Endpoint, CreateEndpointOperationMetadata> response = await endpointServiceClient.CreateEndpointAsync(parent, endpoint);
// Poll until the returned long-running operation is complete
Operation<Endpoint, CreateEndpointOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Endpoint result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Endpoint, CreateEndpointOperationMetadata> retrievedResponse = await endpointServiceClient.PollOnceCreateEndpointAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Endpoint retrievedResult = retrievedResponse.Result;
}
DeleteEndpoint(DeleteEndpointRequest, CallSettings)
public virtual Operation<Empty, DeleteOperationMetadata> DeleteEndpoint(DeleteEndpointRequest request, CallSettings callSettings = null)
Deletes an Endpoint.
Parameters | |
---|---|
Name | Description |
request | DeleteEndpointRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Empty, DeleteOperationMetadata> | The RPC response. |
// Create client
EndpointServiceClient endpointServiceClient = EndpointServiceClient.Create();
// Initialize request argument(s)
DeleteEndpointRequest request = new DeleteEndpointRequest
{
EndpointName = EndpointName.FromProjectLocationEndpoint("[PROJECT]", "[LOCATION]", "[ENDPOINT]"),
};
// Make the request
Operation<Empty, DeleteOperationMetadata> response = endpointServiceClient.DeleteEndpoint(request);
// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = endpointServiceClient.PollOnceDeleteEndpoint(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteEndpoint(EndpointName, CallSettings)
public virtual Operation<Empty, DeleteOperationMetadata> DeleteEndpoint(EndpointName name, CallSettings callSettings = null)
Deletes an Endpoint.
Parameters | |
---|---|
Name | Description |
name | EndpointName Required. The name of the Endpoint resource to be deleted.
Format:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Empty, DeleteOperationMetadata> | The RPC response. |
// Create client
EndpointServiceClient endpointServiceClient = EndpointServiceClient.Create();
// Initialize request argument(s)
EndpointName name = EndpointName.FromProjectLocationEndpoint("[PROJECT]", "[LOCATION]", "[ENDPOINT]");
// Make the request
Operation<Empty, DeleteOperationMetadata> response = endpointServiceClient.DeleteEndpoint(name);
// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = endpointServiceClient.PollOnceDeleteEndpoint(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteEndpoint(String, CallSettings)
public virtual Operation<Empty, DeleteOperationMetadata> DeleteEndpoint(string name, CallSettings callSettings = null)
Deletes an Endpoint.
Parameters | |
---|---|
Name | Description |
name | String Required. The name of the Endpoint resource to be deleted.
Format:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Empty, DeleteOperationMetadata> | The RPC response. |
// Create client
EndpointServiceClient endpointServiceClient = EndpointServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/endpoints/[ENDPOINT]";
// Make the request
Operation<Empty, DeleteOperationMetadata> response = endpointServiceClient.DeleteEndpoint(name);
// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = endpointServiceClient.PollOnceDeleteEndpoint(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteEndpointAsync(DeleteEndpointRequest, CallSettings)
public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteEndpointAsync(DeleteEndpointRequest request, CallSettings callSettings = null)
Deletes an Endpoint.
Parameters | |
---|---|
Name | Description |
request | DeleteEndpointRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Empty, DeleteOperationMetadata>> | A Task containing the RPC response. |
// Create client
EndpointServiceClient endpointServiceClient = await EndpointServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteEndpointRequest request = new DeleteEndpointRequest
{
EndpointName = EndpointName.FromProjectLocationEndpoint("[PROJECT]", "[LOCATION]", "[ENDPOINT]"),
};
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await endpointServiceClient.DeleteEndpointAsync(request);
// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await endpointServiceClient.PollOnceDeleteEndpointAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteEndpointAsync(DeleteEndpointRequest, CancellationToken)
public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteEndpointAsync(DeleteEndpointRequest request, CancellationToken cancellationToken)
Deletes an Endpoint.
Parameters | |
---|---|
Name | Description |
request | DeleteEndpointRequest The request object containing all of the parameters for the API call. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Empty, DeleteOperationMetadata>> | A Task containing the RPC response. |
// Create client
EndpointServiceClient endpointServiceClient = await EndpointServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteEndpointRequest request = new DeleteEndpointRequest
{
EndpointName = EndpointName.FromProjectLocationEndpoint("[PROJECT]", "[LOCATION]", "[ENDPOINT]"),
};
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await endpointServiceClient.DeleteEndpointAsync(request);
// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await endpointServiceClient.PollOnceDeleteEndpointAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteEndpointAsync(EndpointName, CallSettings)
public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteEndpointAsync(EndpointName name, CallSettings callSettings = null)
Deletes an Endpoint.
Parameters | |
---|---|
Name | Description |
name | EndpointName Required. The name of the Endpoint resource to be deleted.
Format:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Empty, DeleteOperationMetadata>> | A Task containing the RPC response. |
// Create client
EndpointServiceClient endpointServiceClient = await EndpointServiceClient.CreateAsync();
// Initialize request argument(s)
EndpointName name = EndpointName.FromProjectLocationEndpoint("[PROJECT]", "[LOCATION]", "[ENDPOINT]");
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await endpointServiceClient.DeleteEndpointAsync(name);
// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await endpointServiceClient.PollOnceDeleteEndpointAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteEndpointAsync(EndpointName, CancellationToken)
public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteEndpointAsync(EndpointName name, CancellationToken cancellationToken)
Deletes an Endpoint.
Parameters | |
---|---|
Name | Description |
name | EndpointName Required. The name of the Endpoint resource to be deleted.
Format:
|
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Empty, DeleteOperationMetadata>> | A Task containing the RPC response. |
// Create client
EndpointServiceClient endpointServiceClient = await EndpointServiceClient.CreateAsync();
// Initialize request argument(s)
EndpointName name = EndpointName.FromProjectLocationEndpoint("[PROJECT]", "[LOCATION]", "[ENDPOINT]");
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await endpointServiceClient.DeleteEndpointAsync(name);
// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await endpointServiceClient.PollOnceDeleteEndpointAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteEndpointAsync(String, CallSettings)
public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteEndpointAsync(string name, CallSettings callSettings = null)
Deletes an Endpoint.
Parameters | |
---|---|
Name | Description |
name | String Required. The name of the Endpoint resource to be deleted.
Format:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Empty, DeleteOperationMetadata>> | A Task containing the RPC response. |
// Create client
EndpointServiceClient endpointServiceClient = await EndpointServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/endpoints/[ENDPOINT]";
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await endpointServiceClient.DeleteEndpointAsync(name);
// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await endpointServiceClient.PollOnceDeleteEndpointAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteEndpointAsync(String, CancellationToken)
public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteEndpointAsync(string name, CancellationToken cancellationToken)
Deletes an Endpoint.
Parameters | |
---|---|
Name | Description |
name | String Required. The name of the Endpoint resource to be deleted.
Format:
|
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Empty, DeleteOperationMetadata>> | A Task containing the RPC response. |
// Create client
EndpointServiceClient endpointServiceClient = await EndpointServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/endpoints/[ENDPOINT]";
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await endpointServiceClient.DeleteEndpointAsync(name);
// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await endpointServiceClient.PollOnceDeleteEndpointAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeployModel(DeployModelRequest, CallSettings)
public virtual Operation<DeployModelResponse, DeployModelOperationMetadata> DeployModel(DeployModelRequest request, CallSettings callSettings = null)
Deploys a Model into this Endpoint, creating a DeployedModel within it.
Parameters | |
---|---|
Name | Description |
request | DeployModelRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<DeployModelResponse, DeployModelOperationMetadata> | The RPC response. |
// Create client
EndpointServiceClient endpointServiceClient = EndpointServiceClient.Create();
// Initialize request argument(s)
DeployModelRequest request = new DeployModelRequest
{
EndpointAsEndpointName = EndpointName.FromProjectLocationEndpoint("[PROJECT]", "[LOCATION]", "[ENDPOINT]"),
DeployedModel = new DeployedModel(),
TrafficSplit = { { "", 0 }, },
};
// Make the request
Operation<DeployModelResponse, DeployModelOperationMetadata> response = endpointServiceClient.DeployModel(request);
// Poll until the returned long-running operation is complete
Operation<DeployModelResponse, DeployModelOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
DeployModelResponse result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<DeployModelResponse, DeployModelOperationMetadata> retrievedResponse = endpointServiceClient.PollOnceDeployModel(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
DeployModelResponse retrievedResult = retrievedResponse.Result;
}
DeployModel(EndpointName, DeployedModel, IDictionary<String, Int32>, CallSettings)
public virtual Operation<DeployModelResponse, DeployModelOperationMetadata> DeployModel(EndpointName endpoint,