LiveVideoAnalyticsAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.visionai_v1.services.live_video_analytics.transports.base.LiveVideoAnalyticsTransport, typing.Callable[[...], google.cloud.visionai_v1.services.live_video_analytics.transports.base.LiveVideoAnalyticsTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Service describing handlers for resources. The service enables clients to run Live Video Analytics (LVA) on the streaming inputs.
Properties
api_endpoint
Return the API endpoint used by the client instance.
Returns | |
---|---|
Type | Description |
str |
The API endpoint used by the client instance. |
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
LiveVideoAnalyticsTransport |
The transport used by the client instance. |
universe_domain
Return the universe domain used by the client instance.
Returns | |
---|---|
Type | Description |
str |
The universe domain used by the client instance. |
Methods
LiveVideoAnalyticsAsyncClient
LiveVideoAnalyticsAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.visionai_v1.services.live_video_analytics.transports.base.LiveVideoAnalyticsTransport, typing.Callable[[...], google.cloud.visionai_v1.services.live_video_analytics.transports.base.LiveVideoAnalyticsTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the live video analytics async client.
Parameters | |
---|---|
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Optional[Union[str,LiveVideoAnalyticsTransport,Callable[..., LiveVideoAnalyticsTransport]]]
The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the LiveVideoAnalyticsTransport constructor. If set to None, a transport is chosen automatically. |
client_options |
Optional[Union[google.api_core.client_options.ClientOptions, dict]]
Custom options for the client. 1. The |
client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTlsChannelError |
If mutual TLS transport creation failed for any reason. |
analysis_path
analysis_path(project: str, location: str, cluster: str, analysis: str) -> str
Returns a fully-qualified analysis string.
batch_run_process
batch_run_process(
request: typing.Optional[
typing.Union[
google.cloud.visionai_v1.types.lva_service.BatchRunProcessRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
requests: typing.Optional[
typing.MutableSequence[
google.cloud.visionai_v1.types.lva_service.CreateProcessRequest
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Run all of the processes to "completion". Max time for each process is the LRO time limit.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1
async def sample_batch_run_process():
# Create a client
client = visionai_v1.LiveVideoAnalyticsAsyncClient()
# Initialize request argument(s)
requests = visionai_v1.CreateProcessRequest()
requests.parent = "parent_value"
requests.process_id = "process_id_value"
requests.process.analysis = "analysis_value"
request = visionai_v1.BatchRunProcessRequest(
parent="parent_value",
requests=requests,
)
# Make the request
operation = client.batch_run_process(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.visionai_v1.types.BatchRunProcessRequest, dict]]
The request object. Request message for running the processes in a batch. |
parent |
Required. The parent resource shared by all processes being created. This corresponds to the |
requests |
:class:
Required. The create process requests. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be BatchRunProcessResponse Response message for running the processes in a batch. |
cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success
is not guaranteed. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
cluster_path
cluster_path(project: str, location: str, cluster: str) -> str
Returns a fully-qualified cluster string.
common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
create_analysis
create_analysis(
request: typing.Optional[
typing.Union[
google.cloud.visionai_v1.types.lva_service.CreateAnalysisRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
analysis: typing.Optional[
google.cloud.visionai_v1.types.lva_resources.Analysis
] = None,
analysis_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new Analysis in a given project and location.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1
async def sample_create_analysis():
# Create a client
client = visionai_v1.LiveVideoAnalyticsAsyncClient()
# Initialize request argument(s)
request = visionai_v1.CreateAnalysisRequest(
parent="parent_value",
analysis_id="analysis_id_value",
)
# Make the request
operation = client.create_analysis(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.visionai_v1.types.CreateAnalysisRequest, dict]]
The request object. Message for creating an Analysis. |
parent |
Required. Value for parent. This corresponds to the |
analysis |
Analysis
Required. The resource being created. This corresponds to the |
analysis_id |
Required. Id of the requesting object. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be Analysis Message describing the Analysis object. |
create_operator
create_operator(
request: typing.Optional[
typing.Union[
google.cloud.visionai_v1.types.lva_service.CreateOperatorRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
operator: typing.Optional[
google.cloud.visionai_v1.types.lva_resources.Operator
] = None,
operator_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new Operator in a given project and location.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1
async def sample_create_operator():
# Create a client
client = visionai_v1.LiveVideoAnalyticsAsyncClient()
# Initialize request argument(s)
request = visionai_v1.CreateOperatorRequest(
parent="parent_value",
operator_id="operator_id_value",
)
# Make the request
operation = client.create_operator(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.visionai_v1.types.CreateOperatorRequest, dict]]
The request object. Message for creating a Operator. |
parent |
Required. Value for parent. This corresponds to the |
operator |
Operator
Required. The resource being created. This corresponds to the |
operator_id |
Required. Id of the requesting object. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be Operator Message describing the Operator object. |
create_process
create_process(
request: typing.Optional[
typing.Union[
google.cloud.visionai_v1.types.lva_service.CreateProcessRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
process: typing.Optional[
google.cloud.visionai_v1.types.lva_resources.Process
] = None,
process_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new Process in a given project and location.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1
async def sample_create_process():
# Create a client
client = visionai_v1.LiveVideoAnalyticsAsyncClient()
# Initialize request argument(s)
process = visionai_v1.Process()
process.analysis = "analysis_value"
request = visionai_v1.CreateProcessRequest(
parent="parent_value",
process_id="process_id_value",
process=process,
)
# Make the request
operation = client.create_process(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.visionai_v1.types.CreateProcessRequest, dict]]
The request object. Message for creating a Process. |
parent |
Required. Value for parent. This corresponds to the |
process |
Process
Required. The resource being created. This corresponds to the |
process_id |
Required. Id of the requesting object. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be Process Message describing the Process object. |
delete_analysis
delete_analysis(
request: typing.Optional[
typing.Union[
google.cloud.visionai_v1.types.lva_service.DeleteAnalysisRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single Analysis.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1
async def sample_delete_analysis():
# Create a client
client = visionai_v1.LiveVideoAnalyticsAsyncClient()
# Initialize request argument(s)
request = visionai_v1.DeleteAnalysisRequest(
name="name_value",
)
# Make the request
operation = client.delete_analysis(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.visionai_v1.types.DeleteAnalysisRequest, dict]]
The request object. Message for deleting an Analysis. |
name |
Required. Name of the resource. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty 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); } |
delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation.
If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
delete_operator
delete_operator(
request: typing.Optional[
typing.Union[
google.cloud.visionai_v1.types.lva_service.DeleteOperatorRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single Operator.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1
async def sample_delete_operator():
# Create a client
client = visionai_v1.LiveVideoAnalyticsAsyncClient()
# Initialize request argument(s)
request = visionai_v1.DeleteOperatorRequest(
name="name_value",
)
# Make the request
operation = client.delete_operator(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.visionai_v1.types.DeleteOperatorRequest, dict]]
The request object. Message for deleting a Operator |
name |
Required. Name of the resource This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty 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); } |
delete_process
delete_process(
request: typing.Optional[
typing.Union[
google.cloud.visionai_v1.types.lva_service.DeleteProcessRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single Process.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1
async def sample_delete_process():
# Create a client
client = visionai_v1.LiveVideoAnalyticsAsyncClient()
# Initialize request argument(s)
request = visionai_v1.DeleteProcessRequest(
name="name_value",
)
# Make the request
operation = client.delete_process(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.visionai_v1.types.DeleteProcessRequest, dict]]
The request object. Message for deleting a Process. |
name |
Required. Name of the resource. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty 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); } |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
LiveVideoAnalyticsAsyncClient |
The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Parameter | |
---|---|
Name | Description |
info |
dict
The service account private key info. |
Returns | |
---|---|
Type | Description |
LiveVideoAnalyticsAsyncClient |
The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
LiveVideoAnalyticsAsyncClient |
The constructed client. |
get_analysis
get_analysis(
request: typing.Optional[
typing.Union[
google.cloud.visionai_v1.types.lva_service.GetAnalysisRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.visionai_v1.types.lva_resources.Analysis
Gets details of a single Analysis.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1
async def sample_get_analysis():
# Create a client
client = visionai_v1.LiveVideoAnalyticsAsyncClient()
# Initialize request argument(s)
request = visionai_v1.GetAnalysisRequest(
name="name_value",
)
# Make the request
response = await client.get_analysis(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.visionai_v1.types.GetAnalysisRequest, dict]]
The request object. Message for getting an Analysis. |
name |
Required. Name of the resource. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.visionai_v1.types.Analysis |
Message describing the Analysis object. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source
is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint
if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is "always", use the
default mTLS endpoint; if the environment variable is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
Parameter | |
---|---|
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError |
If any errors happen. |
Returns | |
---|---|
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] |
returns the API endpoint and the client cert source to use. |
get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
|
An Operation object. |
get_operator
get_operator(
request: typing.Optional[
typing.Union[
google.cloud.visionai_v1.types.lva_service.GetOperatorRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.visionai_v1.types.lva_resources.Operator
Gets details of a single Operator.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1
async def sample_get_operator():
# Create a client
client = visionai_v1.LiveVideoAnalyticsAsyncClient()
# Initialize request argument(s)
request = visionai_v1.GetOperatorRequest(
name="name_value",
)
# Make the request
response = await client.get_operator(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.visionai_v1.types.GetOperatorRequest, dict]]
The request object. Message for getting a Operator. |
name |
Required. Name of the resource. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.visionai_v1.types.Operator |
Message describing the Operator object. |
get_process
get_process(
request: typing.Optional[
typing.Union[google.cloud.visionai_v1.types.lva_service.GetProcessRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.visionai_v1.types.lva_resources.Process
Gets details of a single Process.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1
async def sample_get_process():
# Create a client
client = visionai_v1.LiveVideoAnalyticsAsyncClient()
# Initialize request argument(s)
request = visionai_v1.GetProcessRequest(
name="name_value",
)
# Make the request
response = await client.get_process(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.visionai_v1.types.GetProcessRequest, dict]]
The request object. Message for getting a Process. |
name |
Required. Name of the resource. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.visionai_v1.types.Process |
Message describing the Process object. |
get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.visionai_v1.services.live_video_analytics.transports.base.LiveVideoAnalyticsTransport
]
Returns an appropriate transport class.
Parameter | |
---|---|
Name | Description |
label |
typing.Optional[str]
The name of the desired transport. If none is provided, then the first transport in the registry is used. |
list_analyses
list_analyses(
request: typing.Optional[
typing.Union[
google.cloud.visionai_v1.types.lva_service.ListAnalysesRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.visionai_v1.services.live_video_analytics.pagers.ListAnalysesAsyncPager
)
Lists Analyses in a given project and location.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1
async def sample_list_analyses():
# Create a client
client = visionai_v1.LiveVideoAnalyticsAsyncClient()
# Initialize request argument(s)
request = visionai_v1.ListAnalysesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_analyses(request=request)
# Handle the response
async for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.visionai_v1.types.ListAnalysesRequest, dict]]
The request object. Message for requesting list of Analyses |
parent |
Required. Parent value for ListAnalysesRequest This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.visionai_v1.services.live_video_analytics.pagers.ListAnalysesAsyncPager |
Message for response to listing Analyses Iterating over this object will yield results and resolve additional pages automatically. |
list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
|
Response message for ListOperations method. |
list_operators
list_operators(
request: typing.Optional[
typing.Union[
google.cloud.visionai_v1.types.lva_service.ListOperatorsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.visionai_v1.services.live_video_analytics.pagers.ListOperatorsAsyncPager
)
Lists Operators in a given project and location.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1
async def sample_list_operators():
# Create a client
client = visionai_v1.LiveVideoAnalyticsAsyncClient()
# Initialize request argument(s)
request = visionai_v1.ListOperatorsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_operators(request=request)
# Handle the response
async for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.visionai_v1.types.ListOperatorsRequest, dict]]
The request object. Message for requesting list of Operators. |
parent |
Required. Parent value for ListOperatorsRequest. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.visionai_v1.services.live_video_analytics.pagers.ListOperatorsAsyncPager |
Message for response to listing Operators. Iterating over this object will yield results and resolve additional pages automatically. |
list_processes
list_processes(
request: typing.Optional[
typing.Union[
google.cloud.visionai_v1.types.lva_service.ListProcessesRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.visionai_v1.services.live_video_analytics.pagers.ListProcessesAsyncPager
)
Lists Processes in a given project and location.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1
async def sample_list_processes():
# Create a client
client = visionai_v1.LiveVideoAnalyticsAsyncClient()
# Initialize request argument(s)
request = visionai_v1.ListProcessesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_processes(request=request)
# Handle the response
async for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.visionai_v1.types.ListProcessesRequest, dict]]
The request object. Message for requesting list of Processes. |
parent |
Required. Parent value for ListProcessesRequest. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.visionai_v1.services.live_video_analytics.pagers.ListProcessesAsyncPager |
Message for response to listing Processes. Iterating over this object will yield results and resolve additional pages automatically. |
list_public_operators
list_public_operators(
request: typing.Optional[
typing.Union[
google.cloud.visionai_v1.types.lva_service.ListPublicOperatorsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.visionai_v1.services.live_video_analytics.pagers.ListPublicOperatorsAsyncPager
)
ListPublicOperators returns all the operators in public registry.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1
async def sample_list_public_operators():
# Create a client
client = visionai_v1.LiveVideoAnalyticsAsyncClient()
# Initialize request argument(s)
request = visionai_v1.ListPublicOperatorsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_public_operators(request=request)
# Handle the response
async for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.visionai_v1.types.ListPublicOperatorsRequest, dict]]
The request object. Request message of ListPublicOperatorsRequest API. |
parent |
Required. Parent value for ListPublicOperatorsRequest. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.visionai_v1.services.live_video_analytics.pagers.ListPublicOperatorsAsyncPager |
Response message of ListPublicOperators API. Iterating over this object will yield results and resolve additional pages automatically. |
operator_path
operator_path(project: str, location: str, operator: str) -> str
Returns a fully-qualified operator string.
parse_analysis_path
parse_analysis_path(path: str) -> typing.Dict[str, str]
Parses a analysis path into its component segments.
parse_cluster_path
parse_cluster_path(path: str) -> typing.Dict[str, str]
Parses a cluster path into its component segments.
parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
parse_operator_path
parse_operator_path(path: str) -> typing.Dict[str, str]
Parses a operator path into its component segments.
parse_process_path
parse_process_path(path: str) -> typing.Dict[str, str]
Parses a process path into its component segments.
process_path
process_path(project: str, location: str, cluster: str, process: str) -> str
Returns a fully-qualified process string.
resolve_operator_info
resolve_operator_info(
request: typing.Optional[
typing.Union[
google.cloud.visionai_v1.types.lva_service.ResolveOperatorInfoRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
queries: typing.Optional[
typing.MutableSequence[google.cloud.visionai_v1.types.lva_service.OperatorQuery]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.visionai_v1.types.lva_service.ResolveOperatorInfoResponse
ResolveOperatorInfo returns the operator information based on the request.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1
async def sample_resolve_operator_info():
# Create a client
client = visionai_v1.LiveVideoAnalyticsAsyncClient()
# Initialize request argument(s)
queries = visionai_v1.OperatorQuery()
queries.operator = "operator_value"
request = visionai_v1.ResolveOperatorInfoRequest(
parent="parent_value",
queries=queries,
)
# Make the request
response = await client.resolve_operator_info(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.visionai_v1.types.ResolveOperatorInfoRequest, dict]]
The request object. Request message for querying operator info. |
parent |
Required. Parent value for ResolveOperatorInfoRequest. This corresponds to the |
queries |
:class:
Required. The operator queries. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.visionai_v1.types.ResolveOperatorInfoResponse |
Response message of ResolveOperatorInfo API. |
update_analysis
update_analysis(
request: typing.Optional[
typing.Union[
google.cloud.visionai_v1.types.lva_service.UpdateAnalysisRequest, dict
]
] = None,
*,
analysis: typing.Optional[
google.cloud.visionai_v1.types.lva_resources.Analysis
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates the parameters of a single Analysis.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1
async def sample_update_analysis():
# Create a client
client = visionai_v1.LiveVideoAnalyticsAsyncClient()
# Initialize request argument(s)
request = visionai_v1.UpdateAnalysisRequest(
)
# Make the request
operation = client.update_analysis(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.visionai_v1.types.UpdateAnalysisRequest, dict]]
The request object. Message for updating an Analysis. |
analysis |
Analysis
Required. The resource being updated. This corresponds to the |
update_mask |
Required. Field mask is used to specify the fields to be overwritten in the Analysis resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be Analysis Message describing the Analysis object. |
update_operator
update_operator(
request: typing.Optional[
typing.Union[
google.cloud.visionai_v1.types.lva_service.UpdateOperatorRequest, dict
]
] = None,
*,
operator: typing.Optional[
google.cloud.visionai_v1.types.lva_resources.Operator
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates the parameters of a single Operator.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1
async def sample_update_operator():
# Create a client
client = visionai_v1.LiveVideoAnalyticsAsyncClient()
# Initialize request argument(s)
request = visionai_v1.UpdateOperatorRequest(
)
# Make the request
operation = client.update_operator(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.visionai_v1.types.UpdateOperatorRequest, dict]]
The request object. Message for updating a Operator. |
operator |
Operator
Required. The resource being updated This corresponds to the |
update_mask |
Required. Field mask is used to specify the fields to be overwritten in the Operator resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be Operator Message describing the Operator object. |
update_process
update_process(
request: typing.Optional[
typing.Union[
google.cloud.visionai_v1.types.lva_service.UpdateProcessRequest, dict
]
] = None,
*,
process: typing.Optional[
google.cloud.visionai_v1.types.lva_resources.Process
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates the parameters of a single Process.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1
async def sample_update_process():
# Create a client
client = visionai_v1.LiveVideoAnalyticsAsyncClient()
# Initialize request argument(s)
process = visionai_v1.Process()
process.analysis = "analysis_value"
request = visionai_v1.UpdateProcessRequest(
process=process,
)
# Make the request
operation = client.update_process(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.visionai_v1.types.UpdateProcessRequest, dict]]
The request object. Message for updating a Process. |
process |
Process
Required. The resource being updated. This corresponds to the |
update_mask |
Required. Field mask is used to specify the fields to be overwritten in the Process resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be Process Message describing the Process object. |