Class VideoStitcherServiceAsyncClient (0.2.0)

VideoStitcherServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.video.stitcher_v1.services.video_stitcher_service.transports.base.VideoStitcherServiceTransport] = 'grpc_asyncio', client_options: 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>)

Video-On-Demand content stitching API allows you to insert ads into (VoD) video on demand files. You will be able to render custom scrubber bars with highlighted ads, enforce ad policies, allow seamless playback and tracking on native players and monetize content with any standard VMAP compliant ad server.

Inheritance

builtins.object > VideoStitcherServiceAsyncClient

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
VideoStitcherServiceTransport	The transport used by the client instance.

Methods

VideoStitcherServiceAsyncClient

VideoStitcherServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.video.stitcher_v1.services.video_stitcher_service.transports.base.VideoStitcherServiceTransport] = 'grpc_asyncio', client_options: 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 video stitcher service 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	Union[str, `.VideoStitcherServiceTransport`] The transport to use. If set to None, a transport is chosen automatically.
client_options	`ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.

Exceptions

Type	Description
google.auth.exceptions.MutualTlsChannelError	If mutual TLS transport creation failed for any reason.

cdn_key_path

cdn_key_path(project: str, location: str, cdn_key: str)

Returns a fully-qualified cdn_key string.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_cdn_key

create_cdn_key(request: Optional[Union[google.cloud.video.stitcher_v1.types.video_stitcher_service.CreateCdnKeyRequest, dict]] = None, *, parent: Optional[str] = None, cdn_key: Optional[google.cloud.video.stitcher_v1.types.cdn_keys.CdnKey] = None, cdn_key_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new CDN key.

from google.cloud.video import stitcher_v1

async def sample_create_cdn_key():
    # Create a client
    client = stitcher_v1.VideoStitcherServiceAsyncClient()

    # Initialize request argument(s)
    request = stitcher_v1.CreateCdnKeyRequest(
        parent="parent_value",
        cdn_key_id="cdn_key_id_value",
    )

    # Make the request
    response = await client.create_cdn_key(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.stitcher_v1.types.CreateCdnKeyRequest, dict]` The request object. Request message for VideoStitcherService.createCdnKey.
parent	`str` Required. The project in which the CDN key should be created, in the form of `projects/{project_number}/locations/{location}`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
cdn_key	`CdnKey` Required. The CDN key resource to create. This corresponds to the `cdn_key` field on the `request` instance; if `request` is provided, this should not be set.
cdn_key_id	`str` Required. The ID to use for the CDN key, which will become the final component of the CDN key's resource name. This value should conform to RFC-1034, which restricts to lower-case letters, numbers, and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum. This corresponds to the `cdn_key_id` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` 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.video.stitcher_v1.types.CdnKey	Configuration for a CDN key. Used by the Video Stitcher to sign URIs for fetching video manifests and signing media segments for playback.

create_live_session

create_live_session(request: Optional[Union[google.cloud.video.stitcher_v1.types.video_stitcher_service.CreateLiveSessionRequest, dict]] = None, *, parent: Optional[str] = None, live_session: Optional[google.cloud.video.stitcher_v1.types.sessions.LiveSession] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new live session.

from google.cloud.video import stitcher_v1

async def sample_create_live_session():
    # Create a client
    client = stitcher_v1.VideoStitcherServiceAsyncClient()

    # Initialize request argument(s)
    request = stitcher_v1.CreateLiveSessionRequest(
        parent="parent_value",
    )

    # Make the request
    response = await client.create_live_session(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.stitcher_v1.types.CreateLiveSessionRequest, dict]` The request object. Request message for VideoStitcherService.createLiveSession.
parent	`str` Required. The project and location in which the live session should be created, in the form of `projects/{project_number}/locations/{location}`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
live_session	`LiveSession` Required. Parameters for creating a live session. This corresponds to the `live_session` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` 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.video.stitcher_v1.types.LiveSession	Metadata for a live session.

create_slate

create_slate(request: Optional[Union[google.cloud.video.stitcher_v1.types.video_stitcher_service.CreateSlateRequest, dict]] = None, *, parent: Optional[str] = None, slate: Optional[google.cloud.video.stitcher_v1.types.slates.Slate] = None, slate_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a slate.

from google.cloud.video import stitcher_v1

async def sample_create_slate():
    # Create a client
    client = stitcher_v1.VideoStitcherServiceAsyncClient()

    # Initialize request argument(s)
    request = stitcher_v1.CreateSlateRequest(
        parent="parent_value",
        slate_id="slate_id_value",
    )

    # Make the request
    response = await client.create_slate(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.stitcher_v1.types.CreateSlateRequest, dict]` The request object. Request message for VideoStitcherService.createSlate.
parent	`str` Required. The project in which the slate should be created, in the form of `projects/{project_number}`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
slate	`Slate` Required. The slate to create. This corresponds to the `slate` field on the `request` instance; if `request` is provided, this should not be set.
slate_id	`str` Required. The unique identifier for the slate. This value should conform to RFC-1034, which restricts to lower-case letters, numbers, and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum. This corresponds to the `slate_id` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` 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.video.stitcher_v1.types.Slate	Slate object

create_vod_session

create_vod_session(request: Optional[Union[google.cloud.video.stitcher_v1.types.video_stitcher_service.CreateVodSessionRequest, dict]] = None, *, parent: Optional[str] = None, vod_session: Optional[google.cloud.video.stitcher_v1.types.sessions.VodSession] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a client side playback VOD session and returns the full tracking and playback metadata of the session.

from google.cloud.video import stitcher_v1

async def sample_create_vod_session():
    # Create a client
    client = stitcher_v1.VideoStitcherServiceAsyncClient()

    # Initialize request argument(s)
    vod_session = stitcher_v1.VodSession()
    vod_session.source_uri = "source_uri_value"
    vod_session.ad_tag_uri = "ad_tag_uri_value"

    request = stitcher_v1.CreateVodSessionRequest(
        parent="parent_value",
        vod_session=vod_session,
    )

    # Make the request
    response = await client.create_vod_session(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.stitcher_v1.types.CreateVodSessionRequest, dict]` The request object. Request message for VideoStitcherService.createVodSession
parent	`str` Required. The project and location in which the VOD session should be created, in the form of `projects/{project_number}/locations/{location}`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
vod_session	`VodSession` Required. Parameters for creating a session. This corresponds to the `vod_session` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` 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.video.stitcher_v1.types.VodSession	Metadata for a VOD session.

delete_cdn_key

delete_cdn_key(request: Optional[Union[google.cloud.video.stitcher_v1.types.video_stitcher_service.DeleteCdnKeyRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes the specified CDN key.

from google.cloud.video import stitcher_v1

async def sample_delete_cdn_key():
    # Create a client
    client = stitcher_v1.VideoStitcherServiceAsyncClient()

    # Initialize request argument(s)
    request = stitcher_v1.DeleteCdnKeyRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_cdn_key(request=request)

Parameters

Name	Description
request	`Union[google.cloud.video.stitcher_v1.types.DeleteCdnKeyRequest, dict]` The request object. Request message for VideoStitcherService.deleteCdnKey.
name	`str` Required. The name of the CDN key to be deleted, in the form of `projects/{project_number}/locations/{location}/cdnKeys/{id}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` 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_slate

delete_slate(request: Optional[Union[google.cloud.video.stitcher_v1.types.video_stitcher_service.DeleteSlateRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes the specified slate.

from google.cloud.video import stitcher_v1

async def sample_delete_slate():
    # Create a client
    client = stitcher_v1.VideoStitcherServiceAsyncClient()

    # Initialize request argument(s)
    request = stitcher_v1.DeleteSlateRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_slate(request=request)

Parameters

Name	Description
request	`Union[google.cloud.video.stitcher_v1.types.DeleteSlateRequest, dict]` The request object. Request message for VideoStitcherService.deleteSlate.
name	`str` Required. The name of the slate to be deleted, in the form of `projects/{project_number}/locations/{location}/slates/{id}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` 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.

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
VideoStitcherServiceAsyncClient	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
VideoStitcherServiceAsyncClient	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
VideoStitcherServiceAsyncClient	The constructed client.

get_cdn_key

get_cdn_key(request: Optional[Union[google.cloud.video.stitcher_v1.types.video_stitcher_service.GetCdnKeyRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns the specified CDN key.

from google.cloud.video import stitcher_v1

async def sample_get_cdn_key():
    # Create a client
    client = stitcher_v1.VideoStitcherServiceAsyncClient()

    # Initialize request argument(s)
    request = stitcher_v1.GetCdnKeyRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_cdn_key(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.stitcher_v1.types.GetCdnKeyRequest, dict]` The request object. Request message for VideoStitcherService.getCdnKey.
name	`str` Required. The name of the CDN key to be retrieved, in the form of `projects/{project}/locations/{location}/cdnKeys/{id}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` 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.video.stitcher_v1.types.CdnKey	Configuration for a CDN key. Used by the Video Stitcher to sign URIs for fetching video manifests and signing media segments for playback.

get_live_ad_tag_detail

get_live_ad_tag_detail(request: Optional[Union[google.cloud.video.stitcher_v1.types.video_stitcher_service.GetLiveAdTagDetailRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns the specified ad tag detail for the specified live session.

from google.cloud.video import stitcher_v1

async def sample_get_live_ad_tag_detail():
    # Create a client
    client = stitcher_v1.VideoStitcherServiceAsyncClient()

    # Initialize request argument(s)
    request = stitcher_v1.GetLiveAdTagDetailRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_live_ad_tag_detail(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.stitcher_v1.types.GetLiveAdTagDetailRequest, dict]` The request object. Request message for VideoStitcherService.getLiveAdTagDetail
name	`str` Required. The resource name in the form of `projects/{project}/locations/{location}/liveSessions/{live_session}/liveAdTagDetails/{live_ad_tag_detail}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` 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.video.stitcher_v1.types.LiveAdTagDetail	Container for a live session's ad tag detail.

get_live_session

get_live_session(request: Optional[Union[google.cloud.video.stitcher_v1.types.video_stitcher_service.GetLiveSessionRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns the details for the specified live session.

from google.cloud.video import stitcher_v1

async def sample_get_live_session():
    # Create a client
    client = stitcher_v1.VideoStitcherServiceAsyncClient()

    # Initialize request argument(s)
    request = stitcher_v1.GetLiveSessionRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_live_session(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.stitcher_v1.types.GetLiveSessionRequest, dict]` The request object. Request message for VideoStitcherService.getSession.
name	`str` Required. The name of the live session, in the form of `projects/{project_number}/locations/{location}/liveSessions/{id}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` 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.video.stitcher_v1.types.LiveSession	Metadata for a live session.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: 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 variabel 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 `api_endpoint` and `client_cert_source` properties may be used in this method.

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_slate

get_slate(request: Optional[Union[google.cloud.video.stitcher_v1.types.video_stitcher_service.GetSlateRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns the specified slate.

from google.cloud.video import stitcher_v1

async def sample_get_slate():
    # Create a client
    client = stitcher_v1.VideoStitcherServiceAsyncClient()

    # Initialize request argument(s)
    request = stitcher_v1.GetSlateRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_slate(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.stitcher_v1.types.GetSlateRequest, dict]` The request object. Request message for VideoStitcherService.getSlate.
name	`str` Required. The name of the slate to be retrieved, of the slate, in the form of `projects/{project_number}/locations/{location}/slates/{id}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` 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.video.stitcher_v1.types.Slate	Slate object

get_transport_class

get_transport_class()

Returns an appropriate transport class.

get_vod_ad_tag_detail

get_vod_ad_tag_detail(request: Optional[Union[google.cloud.video.stitcher_v1.types.video_stitcher_service.GetVodAdTagDetailRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns the specified ad tag detail for the specified VOD session.

from google.cloud.video import stitcher_v1

async def sample_get_vod_ad_tag_detail():
    # Create a client
    client = stitcher_v1.VideoStitcherServiceAsyncClient()

    # Initialize request argument(s)
    request = stitcher_v1.GetVodAdTagDetailRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_vod_ad_tag_detail(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.stitcher_v1.types.GetVodAdTagDetailRequest, dict]` The request object. Request message for VideoStitcherService.getVodAdTagDetail
name	`str` Required. The name of the ad tag detail for the specified VOD session, in the form of `projects/{project}/locations/{location}/vodSessions/{vod_session_id}/vodAdTagDetails/{vod_ad_tag_detail}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` 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.video.stitcher_v1.types.VodAdTagDetail	Information related to the details for one ad tag.

get_vod_session

get_vod_session(request: Optional[Union[google.cloud.video.stitcher_v1.types.video_stitcher_service.GetVodSessionRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns the full tracking, playback metadata, and relevant ad-ops logs for the specified VOD session.

from google.cloud.video import stitcher_v1

async def sample_get_vod_session():
    # Create a client
    client = stitcher_v1.VideoStitcherServiceAsyncClient()

    # Initialize request argument(s)
    request = stitcher_v1.GetVodSessionRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_vod_session(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.stitcher_v1.types.GetVodSessionRequest, dict]` The request object. Request message for VideoStitcherService.getVodSession
name	`str` Required. The name of the VOD session to be retrieved, in the form of `projects/{project_number}/locations/{location}/vodSessions/{id}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` 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.video.stitcher_v1.types.VodSession	Metadata for a VOD session.

get_vod_stitch_detail

get_vod_stitch_detail(request: Optional[Union[google.cloud.video.stitcher_v1.types.video_stitcher_service.GetVodStitchDetailRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns the specified stitching information for the specified VOD session.

from google.cloud.video import stitcher_v1

async def sample_get_vod_stitch_detail():
    # Create a client
    client = stitcher_v1.VideoStitcherServiceAsyncClient()

    # Initialize request argument(s)
    request = stitcher_v1.GetVodStitchDetailRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_vod_stitch_detail(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.stitcher_v1.types.GetVodStitchDetailRequest, dict]` The request object. Request message for VideoStitcherService.getVodStitchDetail.
name	`str` Required. The name of the stitch detail in the specified VOD session, in the form of `projects/{project}/locations/{location}/vodSessions/{vod_session_id}/vodStitchDetails/{id}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` 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.video.stitcher_v1.types.VodStitchDetail	Detailed information related to the interstitial of a VOD session.

list_cdn_keys

list_cdn_keys(request: Optional[Union[google.cloud.video.stitcher_v1.types.video_stitcher_service.ListCdnKeysRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists all CDN keys in the specified project and location.

from google.cloud.video import stitcher_v1

async def sample_list_cdn_keys():
    # Create a client
    client = stitcher_v1.VideoStitcherServiceAsyncClient()

    # Initialize request argument(s)
    request = stitcher_v1.ListCdnKeysRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_cdn_keys(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.stitcher_v1.types.ListCdnKeysRequest, dict]` The request object. Request message for VideoStitcherService.listCdnKeys.
parent	`str` Required. The project that contains the list of CDN keys, in the form of `projects/{project_number}/locations/{location}`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` 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.video.stitcher_v1.services.video_stitcher_service.pagers.ListCdnKeysAsyncPager	Response message for VideoStitcher.ListCdnKeys. Iterating over this object will yield results and resolve additional pages automatically.

list_live_ad_tag_details

list_live_ad_tag_details(request: Optional[Union[google.cloud.video.stitcher_v1.types.video_stitcher_service.ListLiveAdTagDetailsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Return the list of ad tag details for the specified live session.

from google.cloud.video import stitcher_v1

async def sample_list_live_ad_tag_details():
    # Create a client
    client = stitcher_v1.VideoStitcherServiceAsyncClient()

    # Initialize request argument(s)
    request = stitcher_v1.ListLiveAdTagDetailsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_live_ad_tag_details(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.stitcher_v1.types.ListLiveAdTagDetailsRequest, dict]` The request object. Request message for VideoStitcherService.listLiveAdTagDetails.
parent	`str` Required. The resource parent in the form of `projects/{project}/locations/{location}/liveSessions/{live_session}`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` 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.video.stitcher_v1.services.video_stitcher_service.pagers.ListLiveAdTagDetailsAsyncPager	Response message for VideoStitcherService.listLiveAdTagDetails. Iterating over this object will yield results and resolve additional pages automatically.

list_slates

list_slates(request: Optional[Union[google.cloud.video.stitcher_v1.types.video_stitcher_service.ListSlatesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists all slates in the specified project and location.

from google.cloud.video import stitcher_v1

async def sample_list_slates():
    # Create a client
    client = stitcher_v1.VideoStitcherServiceAsyncClient()

    # Initialize request argument(s)
    request = stitcher_v1.ListSlatesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_slates(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.stitcher_v1.types.ListSlatesRequest, dict]` The request object. Request message for VideoStitcherService.listSlates.
parent	`str` Required. The project to list slates, in the form of `projects/{project_number}`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` 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.video.stitcher_v1.services.video_stitcher_service.pagers.ListSlatesAsyncPager	Response message for VideoStitcherService.listSlates. Iterating over this object will yield results and resolve additional pages automatically.

list_vod_ad_tag_details

list_vod_ad_tag_details(request: Optional[Union[google.cloud.video.stitcher_v1.types.video_stitcher_service.ListVodAdTagDetailsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Return the list of ad tag details for the specified VOD session.

from google.cloud.video import stitcher_v1

async def sample_list_vod_ad_tag_details():
    # Create a client
    client = stitcher_v1.VideoStitcherServiceAsyncClient()

    # Initialize request argument(s)
    request = stitcher_v1.ListVodAdTagDetailsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_vod_ad_tag_details(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.stitcher_v1.types.ListVodAdTagDetailsRequest, dict]` The request object. Request message for VideoStitcherService.listVodAdTagDetails.
parent	`str` Required. The VOD session which the ad tag details belong to, in the form of `projects/{project}/locations/{location}/vodSessions/{vod_session_id}`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` 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.video.stitcher_v1.services.video_stitcher_service.pagers.ListVodAdTagDetailsAsyncPager	Response message for VideoStitcherService.listVodAdTagDetails. Iterating over this object will yield results and resolve additional pages automatically.

list_vod_stitch_details

list_vod_stitch_details(request: Optional[Union[google.cloud.video.stitcher_v1.types.video_stitcher_service.ListVodStitchDetailsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns a list of detailed stitching information of the specified VOD session.

from google.cloud.video import stitcher_v1

async def sample_list_vod_stitch_details():
    # Create a client
    client = stitcher_v1.VideoStitcherServiceAsyncClient()

    # Initialize request argument(s)
    request = stitcher_v1.ListVodStitchDetailsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_vod_stitch_details(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.stitcher_v1.types.ListVodStitchDetailsRequest, dict]` The request object. Request message for VideoStitcherService.listVodStitchDetails.
parent	`str` Required. The VOD session where the stitch details belong to, in the form of `projects/{project}/locations/{location}/vodSessions/{id}`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` 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.video.stitcher_v1.services.video_stitcher_service.pagers.ListVodStitchDetailsAsyncPager	Response message for VideoStitcherService.listVodStitchDetails. Iterating over this object will yield results and resolve additional pages automatically.

live_ad_tag_detail_path

live_ad_tag_detail_path(
    project: str, location: str, live_session: str, live_ad_tag_detail: str
)

Returns a fully-qualified live_ad_tag_detail string.

live_session_path

live_session_path(project: str, location: str, live_session: str)

Returns a fully-qualified live_session string.

parse_cdn_key_path

parse_cdn_key_path(path: str)

Parses a cdn_key path into its component segments.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_live_ad_tag_detail_path

parse_live_ad_tag_detail_path(path: str)

Parses a live_ad_tag_detail path into its component segments.

parse_live_session_path

parse_live_session_path(path: str)

Parses a live_session path into its component segments.

parse_slate_path

parse_slate_path(path: str)

Parses a slate path into its component segments.

parse_vod_ad_tag_detail_path

parse_vod_ad_tag_detail_path(path: str)

Parses a vod_ad_tag_detail path into its component segments.

parse_vod_session_path

parse_vod_session_path(path: str)

Parses a vod_session path into its component segments.

parse_vod_stitch_detail_path

parse_vod_stitch_detail_path(path: str)

Parses a vod_stitch_detail path into its component segments.

slate_path

slate_path(project: str, location: str, slate: str)

Returns a fully-qualified slate string.

update_cdn_key

update_cdn_key(request: Optional[Union[google.cloud.video.stitcher_v1.types.video_stitcher_service.UpdateCdnKeyRequest, dict]] = None, *, cdn_key: Optional[google.cloud.video.stitcher_v1.types.cdn_keys.CdnKey] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the specified CDN key. Only update fields specified in the call method body.

from google.cloud.video import stitcher_v1

async def sample_update_cdn_key():
    # Create a client
    client = stitcher_v1.VideoStitcherServiceAsyncClient()

    # Initialize request argument(s)
    request = stitcher_v1.UpdateCdnKeyRequest(
    )

    # Make the request
    response = await client.update_cdn_key(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.stitcher_v1.types.UpdateCdnKeyRequest, dict]` The request object. Request message for VideoStitcherService.updateCdnKey.
cdn_key	`CdnKey` Required. The CDN key resource which replaces the resource on the server. This corresponds to the `cdn_key` field on the `request` instance; if `request` is provided, this should not be set.
update_mask	`google.protobuf.field_mask_pb2.FieldMask` Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` 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.video.stitcher_v1.types.CdnKey	Configuration for a CDN key. Used by the Video Stitcher to sign URIs for fetching video manifests and signing media segments for playback.

update_slate

update_slate(request: Optional[Union[google.cloud.video.stitcher_v1.types.video_stitcher_service.UpdateSlateRequest, dict]] = None, *, slate: Optional[google.cloud.video.stitcher_v1.types.slates.Slate] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the specified slate.

from google.cloud.video import stitcher_v1

async def sample_update_slate():
    # Create a client
    client = stitcher_v1.VideoStitcherServiceAsyncClient()

    # Initialize request argument(s)
    request = stitcher_v1.UpdateSlateRequest(
    )

    # Make the request
    response = await client.update_slate(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.stitcher_v1.types.UpdateSlateRequest, dict]` The request object. Request message for VideoStitcherService.updateSlate.
slate	`Slate` Required. The resource with updated fields. This corresponds to the `slate` field on the `request` instance; if `request` is provided, this should not be set.
update_mask	`google.protobuf.field_mask_pb2.FieldMask` Required. The update mask which specifies fields which should be updated. This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` 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.video.stitcher_v1.types.Slate	Slate object

vod_ad_tag_detail_path

vod_ad_tag_detail_path(
    project: str, location: str, vod_session: str, vod_ad_tag_detail: str
)

Returns a fully-qualified vod_ad_tag_detail string.

vod_session_path

vod_session_path(project: str, location: str, vod_session: str)

Returns a fully-qualified vod_session string.

vod_stitch_detail_path

vod_stitch_detail_path(
    project: str, location: str, vod_session: str, vod_stitch_detail: str
)

Returns a fully-qualified vod_stitch_detail string.