create(parent, body=None, servingProfileId=None, x__xgafv=None)

Creates a ServingProfile.

Args:
parent: string, Required. The resource name of the Location to create the ServingProfile in. Format: `projects/{project}/locations/{location}` (required)
body: object, The request body.
The object takes the form of:

{ # Configures the serving behavior for a resource-less GenAI serving.
"cmekConfig": { # Configuration for Customer-Managed Encryption Keys (CMEK). # CMEK configuration for the ServingProfile.
"encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Required. The customer-managed encryption key spec for the Serving Profile.
"kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
},
},
"createTime": "A String", # Output only. Timestamp when the ServingProfile was created.
"description": "A String", # Optional. The description of the ServingProfile.
"displayName": "A String", # Required. The display name of the ServingProfile. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"name": "A String", # Identifier. The resource name of the ServingProfile.
"scope": "A String", # Required. The specific API this ServingProfile applies to.
"updateTime": "A String", # Output only. Timestamp when the ServingProfile was last updated.
}

servingProfileId: string, Required. The ID to use for the ServingProfile, which will become the final component of the ServingProfile's resource name. This value should be 1-63 characters, and valid characters are `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

delete(name, x__xgafv=None)

Deletes a ServingProfile.

Args:
  name: string, Required. The name of the ServingProfile resource to be deleted. Format: `projects/{project}/locations/{location}/servingProfiles/{serving_profile}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

get(name, x__xgafv=None)

Gets a ServingProfile.

Args:
  name: string, Required. The name of the ServingProfile resource. Format: `projects/{project}/locations/{location}/servingProfiles/{serving_profile}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Configures the serving behavior for a resource-less GenAI serving.
  "cmekConfig": { # Configuration for Customer-Managed Encryption Keys (CMEK). # CMEK configuration for the ServingProfile.
    "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Required. The customer-managed encryption key spec for the Serving Profile.
      "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
    },
  },
  "createTime": "A String", # Output only. Timestamp when the ServingProfile was created.
  "description": "A String", # Optional. The description of the ServingProfile.
  "displayName": "A String", # Required. The display name of the ServingProfile. The name can be up to 128 characters long and can consist of any UTF-8 characters.
  "name": "A String", # Identifier. The resource name of the ServingProfile.
  "scope": "A String", # Required. The specific API this ServingProfile applies to.
  "updateTime": "A String", # Output only. Timestamp when the ServingProfile was last updated.
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists ServingProfiles in a Location.

Args:
  parent: string, Required. The resource name of the Location to list the ServingProfiles from. Format: `projects/{project}/locations/{location}` (required)
  pageSize: integer, Optional. The standard list page size. If unspecified, at most 100 ServingProfiles will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  pageToken: string, Optional. The standard list page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for ServingProfileService.ListServingProfiles.
  "nextPageToken": "A String", # Output only. A token to retrieve the next page of results.
  "servingProfiles": [ # Output only. A list of ServingProfiles.
    { # Configures the serving behavior for a resource-less GenAI serving.
      "cmekConfig": { # Configuration for Customer-Managed Encryption Keys (CMEK). # CMEK configuration for the ServingProfile.
        "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Required. The customer-managed encryption key spec for the Serving Profile.
          "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
        },
      },
      "createTime": "A String", # Output only. Timestamp when the ServingProfile was created.
      "description": "A String", # Optional. The description of the ServingProfile.
      "displayName": "A String", # Required. The display name of the ServingProfile. The name can be up to 128 characters long and can consist of any UTF-8 characters.
      "name": "A String", # Identifier. The resource name of the ServingProfile.
      "scope": "A String", # Required. The specific API this ServingProfile applies to.
      "updateTime": "A String", # Output only. Timestamp when the ServingProfile was last updated.
    },
  ],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates a ServingProfile.

Args:
  name: string, Identifier. The resource name of the ServingProfile. (required)
  body: object, The request body.
    The object takes the form of:

{ # Configures the serving behavior for a resource-less GenAI serving.
  "cmekConfig": { # Configuration for Customer-Managed Encryption Keys (CMEK). # CMEK configuration for the ServingProfile.
    "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Required. The customer-managed encryption key spec for the Serving Profile.
      "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
    },
  },
  "createTime": "A String", # Output only. Timestamp when the ServingProfile was created.
  "description": "A String", # Optional. The description of the ServingProfile.
  "displayName": "A String", # Required. The display name of the ServingProfile. The name can be up to 128 characters long and can consist of any UTF-8 characters.
  "name": "A String", # Identifier. The resource name of the ServingProfile.
  "scope": "A String", # Required. The specific API this ServingProfile applies to.
  "updateTime": "A String", # Output only. Timestamp when the ServingProfile was last updated.
}

  updateMask: string, Optional. The list of fields to update; see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. If omitted, all populated (non-empty) mutable fields are updated; if set to `["*"]`, all mutable fields are fully replaced (unpopulated values are cleared).
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Configures the serving behavior for a resource-less GenAI serving.
  "cmekConfig": { # Configuration for Customer-Managed Encryption Keys (CMEK). # CMEK configuration for the ServingProfile.
    "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Required. The customer-managed encryption key spec for the Serving Profile.
      "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
    },
  },
  "createTime": "A String", # Output only. Timestamp when the ServingProfile was created.
  "description": "A String", # Optional. The description of the ServingProfile.
  "displayName": "A String", # Required. The display name of the ServingProfile. The name can be up to 128 characters long and can consist of any UTF-8 characters.
  "name": "A String", # Identifier. The resource name of the ServingProfile.
  "scope": "A String", # Required. The specific API this ServingProfile applies to.
  "updateTime": "A String", # Output only. Timestamp when the ServingProfile was last updated.
}

Agent Platform API . projects . locations . servingProfiles

Instance Methods

Method Details