Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource

The "entityTypes" collection of methods.

Inheritance
object
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Aiplatform.v1beta1
Assembly: Google.Apis.Aiplatform.v1beta1.dll
Syntax
public class ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource

Constructors

EntityTypesResource(IClientService)

Constructs a new resource.

Declaration
public EntityTypesResource(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

Features

Gets the Features resource.

Declaration
public virtual ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.FeaturesResource Features { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.FeaturesResource

Operations

Gets the Operations resource.

Declaration
public virtual ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.OperationsResource Operations { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.OperationsResource

Methods

Create(GoogleCloudAiplatformV1beta1EntityType, string)

Creates a new EntityType in a given Featurestore.

Declaration
public virtual ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.CreateRequest Create(GoogleCloudAiplatformV1beta1EntityType body, string parent)
Parameters
Type Name Description
GoogleCloudAiplatformV1beta1EntityType body

The body of the request.

string parent

Required. The resource name of the Featurestore to create EntityTypes. Format: projects/{project}/locations/{location}/featurestores/{featurestore}

Returns
Type Description
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.CreateRequest

Delete(string)

Deletes a single EntityType. The EntityType must not have any Features or force must be set to true for the request to succeed.

Declaration
public virtual ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

Required. The name of the EntityType to be deleted. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}

Returns
Type Description
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.DeleteRequest

DeleteFeatureValues(GoogleCloudAiplatformV1beta1DeleteFeatureValuesRequest, string)

Delete Feature values from Featurestore. The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done. If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done.

Declaration
public virtual ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.DeleteFeatureValuesRequest DeleteFeatureValues(GoogleCloudAiplatformV1beta1DeleteFeatureValuesRequest body, string entityType)
Parameters
Type Name Description
GoogleCloudAiplatformV1beta1DeleteFeatureValuesRequest body

The body of the request.

string entityType

Required. The resource name of the EntityType grouping the Features for which values are being deleted from. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}

Returns
Type Description
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.DeleteFeatureValuesRequest

ExportFeatureValues(GoogleCloudAiplatformV1beta1ExportFeatureValuesRequest, string)

Exports Feature values from all the entities of a target EntityType.

Declaration
public virtual ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.ExportFeatureValuesRequest ExportFeatureValues(GoogleCloudAiplatformV1beta1ExportFeatureValuesRequest body, string entityType)
Parameters
Type Name Description
GoogleCloudAiplatformV1beta1ExportFeatureValuesRequest body

The body of the request.

string entityType

Required. The resource name of the EntityType from which to export Feature values. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}

Returns
Type Description
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.ExportFeatureValuesRequest

Get(string)

Gets details of a single EntityType.

Declaration
public virtual ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

Required. The name of the EntityType resource. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}

Returns
Type Description
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.GetRequest

GetIamPolicy(string)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Declaration
public virtual ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.GetIamPolicyRequest GetIamPolicy(string resource)
Parameters
Type Name Description
string resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

Returns
Type Description
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.GetIamPolicyRequest

ImportFeatureValues(GoogleCloudAiplatformV1beta1ImportFeatureValuesRequest, string)

Imports Feature values into the Featurestore from a source storage. The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done. If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done. There are also scenarios where the caller can cause inconsistency. - Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned.

Declaration
public virtual ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.ImportFeatureValuesRequest ImportFeatureValues(GoogleCloudAiplatformV1beta1ImportFeatureValuesRequest body, string entityType)
Parameters
Type Name Description
GoogleCloudAiplatformV1beta1ImportFeatureValuesRequest body

The body of the request.

string entityType

Required. The resource name of the EntityType grouping the Features for which values are being imported. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}

Returns
Type Description
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.ImportFeatureValuesRequest

List(string)

Lists EntityTypes in a given Featurestore.

Declaration
public virtual ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

Required. The resource name of the Featurestore to list EntityTypes. Format: projects/{project}/locations/{location}/featurestores/{featurestore}

Returns
Type Description
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.ListRequest

Patch(GoogleCloudAiplatformV1beta1EntityType, string)

Updates the parameters of a single EntityType.

Declaration
public virtual ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.PatchRequest Patch(GoogleCloudAiplatformV1beta1EntityType body, string name)
Parameters
Type Name Description
GoogleCloudAiplatformV1beta1EntityType body

The body of the request.

string name

Immutable. Name of the EntityType. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type} The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore.

Returns
Type Description
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.PatchRequest

ReadFeatureValues(GoogleCloudAiplatformV1beta1ReadFeatureValuesRequest, string)

Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.

Declaration
public virtual ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.ReadFeatureValuesRequest ReadFeatureValues(GoogleCloudAiplatformV1beta1ReadFeatureValuesRequest body, string entityType)
Parameters
Type Name Description
GoogleCloudAiplatformV1beta1ReadFeatureValuesRequest body

The body of the request.

string entityType

Required. The resource name of the EntityType for the entity being read. Value format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.

Returns
Type Description
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.ReadFeatureValuesRequest

SetIamPolicy(GoogleIamV1SetIamPolicyRequest, string)

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Declaration
public virtual ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.SetIamPolicyRequest SetIamPolicy(GoogleIamV1SetIamPolicyRequest body, string resource)
Parameters
Type Name Description
GoogleIamV1SetIamPolicyRequest body

The body of the request.

string resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

Returns
Type Description
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.SetIamPolicyRequest

StreamingReadFeatureValues(GoogleCloudAiplatformV1beta1StreamingReadFeatureValuesRequest, string)

Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.

Declaration
public virtual ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.StreamingReadFeatureValuesRequest StreamingReadFeatureValues(GoogleCloudAiplatformV1beta1StreamingReadFeatureValuesRequest body, string entityType)
Parameters
Type Name Description
GoogleCloudAiplatformV1beta1StreamingReadFeatureValuesRequest body

The body of the request.

string entityType

Required. The resource name of the entities' type. Value format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.

Returns
Type Description
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.StreamingReadFeatureValuesRequest

TestIamPermissions(string)

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Declaration
public virtual ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.TestIamPermissionsRequest TestIamPermissions(string resource)
Parameters
Type Name Description
string resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

Returns
Type Description
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.TestIamPermissionsRequest

WriteFeatureValues(GoogleCloudAiplatformV1beta1WriteFeatureValuesRequest, string)

Writes Feature values of one or more entities of an EntityType. The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.

Declaration
public virtual ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.WriteFeatureValuesRequest WriteFeatureValues(GoogleCloudAiplatformV1beta1WriteFeatureValuesRequest body, string entityType)
Parameters
Type Name Description
GoogleCloudAiplatformV1beta1WriteFeatureValuesRequest body

The body of the request.

string entityType

Required. The resource name of the EntityType for the entities being written. Value format: projects/{project}/locations/{location}/featurestores/ {featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.

Returns
Type Description
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.WriteFeatureValuesRequest
In this article
Back to top Generated by DocFX