Class LicenseConfigServiceClient (0.20.1)

LicenseConfigServiceClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1beta.services.license_config_service.transports.base.LicenseConfigServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1beta.services.license_config_service.transports.base.LicenseConfigServiceTransport,
            ],
        ]
    ] = None,
    client_options: typing.Optional[
        typing.Union[google.api_core.client_options.ClientOptions, dict]
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)

Service for managing license config related resources.

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
`LicenseConfigServiceTransport`	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

LicenseConfigServiceClient

LicenseConfigServiceClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1beta.services.license_config_service.transports.base.LicenseConfigServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1beta.services.license_config_service.transports.base.LicenseConfigServiceTransport,
            ],
        ]
    ] = None,
    client_options: typing.Optional[
        typing.Union[google.api_core.client_options.ClientOptions, dict]
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)

Instantiates the license config 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`	`Optional[Union[str,LicenseConfigServiceTransport,Callable[..., LicenseConfigServiceTransport]]]` The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the LicenseConfigServiceTransport 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 `api_endpoint` property can be used to override the default endpoint provided by the client when `transport` is not explicitly provided. Only if this property is not set and `transport` was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "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). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide a client certificate for mTLS 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. 3. The `universe_domain` property can be used to override the default "googleapis.com" universe. Note that the `api_endpoint` property still takes precedence; and `universe_domain` is currently not supported for mTLS.
`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 `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If mutual TLS transport creation failed for any reason.

exit

__exit__(type, value, traceback)

Releases underlying transport's resources.

billing_account_license_config_path

billing_account_license_config_path(
    billing_account: str, billing_account_license_config: str
) -> str

Returns a fully-qualified billing_account_license_config string.

cancel_operation

cancel_operation(
    request: typing.Optional[
        typing.Union[google.longrunning.operations_pb2.CancelOperationRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> 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`	`.operations_pb2.CancelOperationRequest` The request object. Request message for `CancelOperation` method.
`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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

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_license_config

create_license_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1beta.types.license_config_service.CreateLicenseConfigRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    license_config: typing.Optional[
        google.cloud.discoveryengine_v1beta.types.license_config.LicenseConfig
    ] = None,
    license_config_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1beta.types.license_config.LicenseConfig

Creates a xref_LicenseConfig This method should only be used for creating NotebookLm licenses or Gemini Enterprise free trial licenses.

# 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 discoveryengine_v1beta

def sample_create_license_config():
    # Create a client
    client = discoveryengine_v1beta.LicenseConfigServiceClient()

    # Initialize request argument(s)
    license_config = discoveryengine_v1beta.LicenseConfig()
    license_config.license_count = 1387
    license_config.subscription_tier = "SUBSCRIPTION_TIER_FRONTLINE_STARTER"
    license_config.subscription_term = "SUBSCRIPTION_TERM_CUSTOM"

    request = discoveryengine_v1beta.CreateLicenseConfigRequest(
        parent="parent_value",
        license_config=license_config,
    )

    # Make the request
    response = client.create_license_config(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.discoveryengine_v1beta.types.CreateLicenseConfigRequest, dict]` The request object. Request message for LicenseConfigService.CreateLicenseConfig method.
`parent`	`str` Required. The parent resource name, such as `projects/{project}/locations/{location}`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`license_config`	`google.cloud.discoveryengine_v1beta.types.LicenseConfig` Required. The LicenseConfig to create. This corresponds to the `license_config` field on the `request` instance; if `request` is provided, this should not be set.
`license_config_id`	`str` Optional. The ID to use for the LicenseConfig, which will become the final component of the LicenseConfig's resource name. We are using the tier (product edition) name as the license config id such as `search` or `search_and_assistant`. This corresponds to the `license_config_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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.cloud.discoveryengine_v1beta.types.LicenseConfig`	Information about users' licenses.

distribute_license_config

distribute_license_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1beta.types.license_config_service.DistributeLicenseConfigRequest,
            dict,
        ]
    ] = None,
    *,
    billing_account_license_config: typing.Optional[str] = None,
    project_number: typing.Optional[int] = None,
    location: typing.Optional[str] = None,
    license_count: typing.Optional[int] = None,
    license_config_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1beta.types.license_config_service.DistributeLicenseConfigResponse
)

Distributes a xref_LicenseConfig from billing account level to project level.

# 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 discoveryengine_v1beta

def sample_distribute_license_config():
    # Create a client
    client = discoveryengine_v1beta.LicenseConfigServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1beta.DistributeLicenseConfigRequest(
        billing_account_license_config="billing_account_license_config_value",
        project_number=1503,
        location="location_value",
        license_count=1387,
    )

    # Make the request
    response = client.distribute_license_config(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.discoveryengine_v1beta.types.DistributeLicenseConfigRequest, dict]` The request object. Request message for LicenseConfigService.DistributeLicenseConfig method.
`billing_account_license_config`	`str` Required. Full resource name of [BillingAccountLicenseConfig][]. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`. This corresponds to the `billing_account_license_config` field on the `request` instance; if `request` is provided, this should not be set.
`project_number`	`int` Required. The target GCP project number to distribute the license config to. This corresponds to the `project_number` field on the `request` instance; if `request` is provided, this should not be set.
`location`	`str` Required. The target GCP project region to distribute the license config to. This corresponds to the `location` field on the `request` instance; if `request` is provided, this should not be set.
`license_count`	`int` Required. The number of licenses to distribute. This corresponds to the `license_count` field on the `request` instance; if `request` is provided, this should not be set.
`license_config_id`	`str` Optional. Distribute seats to this license config instead of creating a new one. If not specified, a new license config will be created from the billing account license config. This corresponds to the `license_config_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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.cloud.discoveryengine_v1beta.types.DistributeLicenseConfigResponse`	Response message for LicenseConfigService.DistributeLicenseConfig method.

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

get_license_config

get_license_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1beta.types.license_config_service.GetLicenseConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1beta.types.license_config.LicenseConfig

Gets a xref_LicenseConfig.

# 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 discoveryengine_v1beta

def sample_get_license_config():
    # Create a client
    client = discoveryengine_v1beta.LicenseConfigServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1beta.GetLicenseConfigRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_license_config(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.discoveryengine_v1beta.types.GetLicenseConfigRequest, dict]` The request object. Request message for LicenseConfigService.GetLicenseConfig method.
`name`	`str` Required. Full resource name of LicenseConfig, such as `projects/{project}/locations/{location}/licenseConfigs/*`. If the caller does not have permission to access the LicenseConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested LicenseConfig does not exist, a NOT_FOUND error is returned. 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.cloud.discoveryengine_v1beta.types.LicenseConfig`	Information about users' licenses.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated. 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 `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_operation

get_operation(
    request: typing.Optional[
        typing.Union[google.longrunning.operations_pb2.GetOperationRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters
Name	Description
`request`	`.operations_pb2.GetOperationRequest` The request object. Request message for `GetOperation` method.
`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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`.operations_pb2.Operation`	An `Operation` object.

license_config_path

license_config_path(project: str, location: str, license_config: str) -> str

Returns a fully-qualified license_config string.

list_license_configs

list_license_configs(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1beta.types.license_config_service.ListLicenseConfigsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1beta.services.license_config_service.pagers.ListLicenseConfigsPager
)

Lists all the xref_LicenseConfigs associated with the project.

# 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 discoveryengine_v1beta

def sample_list_license_configs():
    # Create a client
    client = discoveryengine_v1beta.LicenseConfigServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1beta.ListLicenseConfigsRequest(
        parent="parent_value",
    )

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

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

Parameters
Name	Description
`request`	`Union[google.cloud.discoveryengine_v1beta.types.ListLicenseConfigsRequest, dict]` The request object. Request message for LicenseConfigService.ListLicenseConfigs method.
`parent`	`str` Required. The parent branch resource name, such as `projects/{project}/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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.cloud.discoveryengine_v1beta.services.license_config_service.pagers.ListLicenseConfigsPager`	Response message for LicenseConfigService.ListLicenseConfigs method. Iterating over this object will yield results and resolve additional pages automatically.

list_operations

list_operations(
    request: typing.Optional[
        typing.Union[google.longrunning.operations_pb2.ListOperationsRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters
Name	Description
`request`	`.operations_pb2.ListOperationsRequest` The request object. Request message for `ListOperations` method.
`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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`.operations_pb2.ListOperationsResponse`	Response message for `ListOperations` method.

location_path

location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

parse_billing_account_license_config_path

parse_billing_account_license_config_path(path: str) -> typing.Dict[str, str]

Parses a billing_account_license_config 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_license_config_path

parse_license_config_path(path: str) -> typing.Dict[str, str]

Parses a license_config path into its component segments.

parse_location_path

parse_location_path(path: str) -> typing.Dict[str, str]

Parses a location path into its component segments.

retract_license_config

retract_license_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1beta.types.license_config_service.RetractLicenseConfigRequest,
            dict,
        ]
    ] = None,
    *,
    billing_account_license_config: typing.Optional[str] = None,
    license_config: typing.Optional[str] = None,
    full_retract: typing.Optional[bool] = None,
    license_count: typing.Optional[int] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1beta.types.license_config_service.RetractLicenseConfigResponse
)

This method is called from the billing account side to retract the xref_LicenseConfig from the given project back to the billing account.

# 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 discoveryengine_v1beta

def sample_retract_license_config():
    # Create a client
    client = discoveryengine_v1beta.LicenseConfigServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1beta.RetractLicenseConfigRequest(
        billing_account_license_config="billing_account_license_config_value",
        license_config="license_config_value",
    )

    # Make the request
    response = client.retract_license_config(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.discoveryengine_v1beta.types.RetractLicenseConfigRequest, dict]` The request object. Request message for LicenseConfigService.RetractLicenseConfig method.
`billing_account_license_config`	`str` Required. Full resource name of [BillingAccountLicenseConfig][]. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`. This corresponds to the `billing_account_license_config` field on the `request` instance; if `request` is provided, this should not be set.
`license_config`	`str` Required. Full resource name of LicenseConfig. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config_id}`. This corresponds to the `license_config` field on the `request` instance; if `request` is provided, this should not be set.
`full_retract`	`bool` Optional. If set to true, retract the entire license config. Otherwise, retract the specified license count. This corresponds to the `full_retract` field on the `request` instance; if `request` is provided, this should not be set.
`license_count`	`int` Optional. The number of licenses to retract. Only used when full_retract is false. This corresponds to the `license_count` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.cloud.discoveryengine_v1beta.types.RetractLicenseConfigResponse`	Response message for LicenseConfigService.RetractLicenseConfig method.

update_license_config

update_license_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1beta.types.license_config_service.UpdateLicenseConfigRequest,
            dict,
        ]
    ] = None,
    *,
    license_config: typing.Optional[
        google.cloud.discoveryengine_v1beta.types.license_config.LicenseConfig
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1beta.types.license_config.LicenseConfig

Updates the xref_LicenseConfig

# 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 discoveryengine_v1beta

def sample_update_license_config():
    # Create a client
    client = discoveryengine_v1beta.LicenseConfigServiceClient()

    # Initialize request argument(s)
    license_config = discoveryengine_v1beta.LicenseConfig()
    license_config.license_count = 1387
    license_config.subscription_tier = "SUBSCRIPTION_TIER_FRONTLINE_STARTER"
    license_config.subscription_term = "SUBSCRIPTION_TERM_CUSTOM"

    request = discoveryengine_v1beta.UpdateLicenseConfigRequest(
        license_config=license_config,
    )

    # Make the request
    response = client.update_license_config(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.discoveryengine_v1beta.types.UpdateLicenseConfigRequest, dict]` The request object. Request message for LicenseConfigService.UpdateLicenseConfig method.
`license_config`	`google.cloud.discoveryengine_v1beta.types.LicenseConfig` Required. The LicenseConfig to update. This corresponds to the `license_config` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` Optional. Indicates which fields in the provided LicenseConfig to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.cloud.discoveryengine_v1beta.types.LicenseConfig`	Information about users' licenses.