As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

PermissionService¶

class google.ai.generativelanguage_v1beta3.services.permission_service.PermissionServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.ai.generativelanguage_v1beta3.services.permission_service.transports.base.PermissionServiceTransport, typing.Callable[[...], google.ai.generativelanguage_v1beta3.services.permission_service.transports.base.PermissionServiceTransport]]] = '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>)[source]¶

Provides methods for managing permissions to PaLM API resources.

Instantiates the permission service async client.

Parameters

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,PermissionServiceTransport,Callable[..., PermissionServiceTransport]]]) – 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 PermissionServiceTransport 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 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.

Raises

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

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static common_billing_account_path(billing_account: str) → str¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str¶: Returns a fully-qualified project string.

async create_permission(request: Optional[Union[google.ai.generativelanguage_v1beta3.types.permission_service.CreatePermissionRequest, dict]] = None, *, parent: Optional[str] = None, permission: Optional[google.ai.generativelanguage_v1beta3.types.permission.Permission] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.ai.generativelanguage_v1beta3.types.permission.Permission[source]¶

Create a permission to a specific resource.

# 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.ai import generativelanguage_v1beta3

async def sample_create_permission():
    # Create a client
    client = generativelanguage_v1beta3.PermissionServiceAsyncClient()

    # Initialize request argument(s)
    request = generativelanguage_v1beta3.CreatePermissionRequest(
        parent="parent_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.ai.generativelanguage_v1beta3.types.CreatePermissionRequest, dict]]) – The request object. Request to create a Permission.
parent (str) –
Required. The parent resource of the Permission. Format: tunedModels/{tuned_model}

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
permission (google.ai.generativelanguage_v1beta3.types.Permission) – Required. The permission to create. This corresponds to the permission field on the request instance; if request is provided, this should not be set.
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

Permission resource grants user, group or the rest of the world access to the PaLM API resource (e.g. a tuned model, file).

A role is a collection of permitted operations that allows users to perform specific actions on PaLM API resources. To make them available to users, groups, or service accounts, you assign roles. When you assign a role, you grant permissions that the role contains.

There are three concentric roles. Each role is a superset of the previous role’s permitted operations:

reader can use the resource (e.g. tuned model) for inference
writer has reader’s permissions and additionally can edit and share
owner has writer’s permissions and additionally can delete

Return type

google.ai.generativelanguage_v1beta3.types.Permission

async delete_permission(request: Optional[Union[google.ai.generativelanguage_v1beta3.types.permission_service.DeletePermissionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Deletes the permission.

# 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.ai import generativelanguage_v1beta3

async def sample_delete_permission():
    # Create a client
    client = generativelanguage_v1beta3.PermissionServiceAsyncClient()

    # Initialize request argument(s)
    request = generativelanguage_v1beta3.DeletePermissionRequest(
        name="name_value",
    )

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

Parameters

request (Optional[Union[google.ai.generativelanguage_v1beta3.types.DeletePermissionRequest, dict]]) – The request object. Request to delete the Permission.
name (str) –
Required. The resource name of the permission. Format: tunedModels/{tuned_model}/permissions/{permission}

This corresponds to the name field on the request instance; if request is provided, this should not be set.
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.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

PermissionServiceAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: info.

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

PermissionServiceAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

PermissionServiceAsyncClient

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

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.

Parameters

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.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

async get_permission(request: Optional[Union[google.ai.generativelanguage_v1beta3.types.permission_service.GetPermissionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.ai.generativelanguage_v1beta3.types.permission.Permission[source]¶

Gets information about a specific Permission.

# 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.ai import generativelanguage_v1beta3

async def sample_get_permission():
    # Create a client
    client = generativelanguage_v1beta3.PermissionServiceAsyncClient()

    # Initialize request argument(s)
    request = generativelanguage_v1beta3.GetPermissionRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.ai.generativelanguage_v1beta3.types.GetPermissionRequest, dict]]) – The request object. Request for getting information about a specific Permission.
name (str) –
Required. The resource name of the permission.

Format: tunedModels/{tuned_model}permissions/{permission}

This corresponds to the name field on the request instance; if request is provided, this should not be set.
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

Permission resource grants user, group or the rest of the world access to the PaLM API resource (e.g. a tuned model, file).

A role is a collection of permitted operations that allows users to perform specific actions on PaLM API resources. To make them available to users, groups, or service accounts, you assign roles. When you assign a role, you grant permissions that the role contains.

There are three concentric roles. Each role is a superset of the previous role’s permitted operations:

reader can use the resource (e.g. tuned model) for inference
writer has reader’s permissions and additionally can edit and share
owner has writer’s permissions and additionally can delete

Return type

google.ai.generativelanguage_v1beta3.types.Permission

classmethod get_transport_class(label: Optional[str] = None) → Type[google.ai.generativelanguage_v1beta3.services.permission_service.transports.base.PermissionServiceTransport]¶

Returns an appropriate transport class.

Parameters: label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
Returns: The transport class to use.

async list_permissions(request: Optional[Union[google.ai.generativelanguage_v1beta3.types.permission_service.ListPermissionsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.ai.generativelanguage_v1beta3.services.permission_service.pagers.ListPermissionsAsyncPager[source]¶

Lists permissions for the specific resource.

# 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.ai import generativelanguage_v1beta3

async def sample_list_permissions():
    # Create a client
    client = generativelanguage_v1beta3.PermissionServiceAsyncClient()

    # Initialize request argument(s)
    request = generativelanguage_v1beta3.ListPermissionsRequest(
        parent="parent_value",
    )

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

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

Parameters

request (Optional[Union[google.ai.generativelanguage_v1beta3.types.ListPermissionsRequest, dict]]) – The request object. Request for listing permissions.
parent (str) –
Required. The parent resource of the permissions. Format: tunedModels/{tuned_model}

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
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

Response from ListPermissions containing a paginated list of: permissions.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.ai.generativelanguage_v1beta3.services.permission_service.pagers.ListPermissionsAsyncPager

static parse_common_billing_account_path(path: str) → Dict[str, str]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]¶: Parse a project path into its component segments.

static parse_permission_path(path: str) → Dict[str, str]¶: Parses a permission path into its component segments.

static parse_tuned_model_path(path: str) → Dict[str, str]¶: Parses a tuned_model path into its component segments.

static permission_path(tuned_model: str, permission: str) → str¶: Returns a fully-qualified permission string.

async transfer_ownership(request: Optional[Union[google.ai.generativelanguage_v1beta3.types.permission_service.TransferOwnershipRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.ai.generativelanguage_v1beta3.types.permission_service.TransferOwnershipResponse[source]¶

Transfers ownership of the tuned model. This is the only way to change ownership of the tuned model. The current owner will be downgraded to writer role.

# 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.ai import generativelanguage_v1beta3

async def sample_transfer_ownership():
    # Create a client
    client = generativelanguage_v1beta3.PermissionServiceAsyncClient()

    # Initialize request argument(s)
    request = generativelanguage_v1beta3.TransferOwnershipRequest(
        name="name_value",
        email_address="email_address_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.ai.generativelanguage_v1beta3.types.TransferOwnershipRequest, dict]]) – The request object. Request to transfer the ownership of the tuned model.
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

Response from TransferOwnership.

Return type

google.ai.generativelanguage_v1beta3.types.TransferOwnershipResponse

property transport: google.ai.generativelanguage_v1beta3.services.permission_service.transports.base.PermissionServiceTransport¶

Returns the transport used by the client instance.

Returns: The transport used by the client instance.
Return type: PermissionServiceTransport

static tuned_model_path(tuned_model: str) → str¶: Returns a fully-qualified tuned_model string.

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns

The universe domain used: by the client instance.

Return type

str

async update_permission(request: Optional[Union[google.ai.generativelanguage_v1beta3.types.permission_service.UpdatePermissionRequest, dict]] = None, *, permission: Optional[google.ai.generativelanguage_v1beta3.types.permission.Permission] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.ai.generativelanguage_v1beta3.types.permission.Permission[source]¶

Updates the permission.

# 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.ai import generativelanguage_v1beta3

async def sample_update_permission():
    # Create a client
    client = generativelanguage_v1beta3.PermissionServiceAsyncClient()

    # Initialize request argument(s)
    request = generativelanguage_v1beta3.UpdatePermissionRequest(
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.ai.generativelanguage_v1beta3.types.UpdatePermissionRequest, dict]]) – The request object. Request to update the Permission.
permission (google.ai.generativelanguage_v1beta3.types.Permission) –
Required. The permission to update.

The permission’s name field is used to identify the permission to update.

This corresponds to the permission field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Required. The list of fields to update. Accepted ones:
- role (Permission.role field)
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_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

Permission resource grants user, group or the rest of the world access to the PaLM API resource (e.g. a tuned model, file).

A role is a collection of permitted operations that allows users to perform specific actions on PaLM API resources. To make them available to users, groups, or service accounts, you assign roles. When you assign a role, you grant permissions that the role contains.

There are three concentric roles. Each role is a superset of the previous role’s permitted operations:

reader can use the resource (e.g. tuned model) for inference
writer has reader’s permissions and additionally can edit and share
owner has writer’s permissions and additionally can delete

Return type

google.ai.generativelanguage_v1beta3.types.Permission

class google.ai.generativelanguage_v1beta3.services.permission_service.PermissionServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.ai.generativelanguage_v1beta3.services.permission_service.transports.base.PermissionServiceTransport, typing.Callable[[...], google.ai.generativelanguage_v1beta3.services.permission_service.transports.base.PermissionServiceTransport]]] = 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 object>)[source]¶

Provides methods for managing permissions to PaLM API resources.

Instantiates the permission service client.

Parameters

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,PermissionServiceTransport,Callable[..., PermissionServiceTransport]]]) – 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 PermissionServiceTransport 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.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]¶: Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static common_billing_account_path(billing_account: str) → str[source]¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]¶: Returns a fully-qualified project string.

create_permission(request: Optional[Union[google.ai.generativelanguage_v1beta3.types.permission_service.CreatePermissionRequest, dict]] = None, *, parent: Optional[str] = None, permission: Optional[google.ai.generativelanguage_v1beta3.types.permission.Permission] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.ai.generativelanguage_v1beta3.types.permission.Permission[source]¶

Create a permission to a specific resource.

# 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.ai import generativelanguage_v1beta3

def sample_create_permission():
    # Create a client
    client = generativelanguage_v1beta3.PermissionServiceClient()

    # Initialize request argument(s)
    request = generativelanguage_v1beta3.CreatePermissionRequest(
        parent="parent_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ai.generativelanguage_v1beta3.types.CreatePermissionRequest, dict]) – The request object. Request to create a Permission.
parent (str) –
Required. The parent resource of the Permission. Format: tunedModels/{tuned_model}

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
permission (google.ai.generativelanguage_v1beta3.types.Permission) – Required. The permission to create. This corresponds to the permission 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

Permission resource grants user, group or the rest of the world access to the PaLM API resource (e.g. a tuned model, file).

A role is a collection of permitted operations that allows users to perform specific actions on PaLM API resources. To make them available to users, groups, or service accounts, you assign roles. When you assign a role, you grant permissions that the role contains.

There are three concentric roles. Each role is a superset of the previous role’s permitted operations:

reader can use the resource (e.g. tuned model) for inference
writer has reader’s permissions and additionally can edit and share
owner has writer’s permissions and additionally can delete

Return type

google.ai.generativelanguage_v1beta3.types.Permission

delete_permission(request: Optional[Union[google.ai.generativelanguage_v1beta3.types.permission_service.DeletePermissionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Deletes the permission.

# 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.ai import generativelanguage_v1beta3

def sample_delete_permission():
    # Create a client
    client = generativelanguage_v1beta3.PermissionServiceClient()

    # Initialize request argument(s)
    request = generativelanguage_v1beta3.DeletePermissionRequest(
        name="name_value",
    )

    # Make the request
    client.delete_permission(request=request)

Parameters

request (Union[google.ai.generativelanguage_v1beta3.types.DeletePermissionRequest, dict]) – The request object. Request to delete the Permission.
name (str) –
Required. The resource name of the permission. Format: tunedModels/{tuned_model}/permissions/{permission}

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.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

PermissionServiceClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: info.

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

PermissionServiceClient

classmethod from_service_account_json(filename: str, *args, **kwargs)¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

PermissionServiceClient

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

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.

Parameters

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.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_permission(request: Optional[Union[google.ai.generativelanguage_v1beta3.types.permission_service.GetPermissionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.ai.generativelanguage_v1beta3.types.permission.Permission[source]¶

Gets information about a specific Permission.

# 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.ai import generativelanguage_v1beta3

def sample_get_permission():
    # Create a client
    client = generativelanguage_v1beta3.PermissionServiceClient()

    # Initialize request argument(s)
    request = generativelanguage_v1beta3.GetPermissionRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ai.generativelanguage_v1beta3.types.GetPermissionRequest, dict]) – The request object. Request for getting information about a specific Permission.
name (str) –
Required. The resource name of the permission.

Format: tunedModels/{tuned_model}permissions/{permission}

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

Permission resource grants user, group or the rest of the world access to the PaLM API resource (e.g. a tuned model, file).

A role is a collection of permitted operations that allows users to perform specific actions on PaLM API resources. To make them available to users, groups, or service accounts, you assign roles. When you assign a role, you grant permissions that the role contains.

There are three concentric roles. Each role is a superset of the previous role’s permitted operations:

reader can use the resource (e.g. tuned model) for inference
writer has reader’s permissions and additionally can edit and share
owner has writer’s permissions and additionally can delete

Return type

google.ai.generativelanguage_v1beta3.types.Permission

list_permissions(request: Optional[Union[google.ai.generativelanguage_v1beta3.types.permission_service.ListPermissionsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.ai.generativelanguage_v1beta3.services.permission_service.pagers.ListPermissionsPager[source]¶

Lists permissions for the specific resource.

# 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.ai import generativelanguage_v1beta3

def sample_list_permissions():
    # Create a client
    client = generativelanguage_v1beta3.PermissionServiceClient()

    # Initialize request argument(s)
    request = generativelanguage_v1beta3.ListPermissionsRequest(
        parent="parent_value",
    )

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

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

Parameters

request (Union[google.ai.generativelanguage_v1beta3.types.ListPermissionsRequest, dict]) – The request object. Request for listing permissions.
parent (str) –
Required. The parent resource of the permissions. Format: tunedModels/{tuned_model}

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

Response from ListPermissions containing a paginated list of: permissions.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.ai.generativelanguage_v1beta3.services.permission_service.pagers.ListPermissionsPager

static parse_common_billing_account_path(path: str) → Dict[str, str][source]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]¶: Parse a project path into its component segments.

static parse_permission_path(path: str) → Dict[str, str][source]¶: Parses a permission path into its component segments.

static parse_tuned_model_path(path: str) → Dict[str, str][source]¶: Parses a tuned_model path into its component segments.

static permission_path(tuned_model: str, permission: str) → str[source]¶: Returns a fully-qualified permission string.

transfer_ownership(request: Optional[Union[google.ai.generativelanguage_v1beta3.types.permission_service.TransferOwnershipRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.ai.generativelanguage_v1beta3.types.permission_service.TransferOwnershipResponse[source]¶

Transfers ownership of the tuned model. This is the only way to change ownership of the tuned model. The current owner will be downgraded to writer role.

# 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.ai import generativelanguage_v1beta3

def sample_transfer_ownership():
    # Create a client
    client = generativelanguage_v1beta3.PermissionServiceClient()

    # Initialize request argument(s)
    request = generativelanguage_v1beta3.TransferOwnershipRequest(
        name="name_value",
        email_address="email_address_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ai.generativelanguage_v1beta3.types.TransferOwnershipRequest, dict]) – The request object. Request to transfer the ownership of the tuned model.
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

Response from TransferOwnership.

Return type

google.ai.generativelanguage_v1beta3.types.TransferOwnershipResponse

property transport: google.ai.generativelanguage_v1beta3.services.permission_service.transports.base.PermissionServiceTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

PermissionServiceTransport

static tuned_model_path(tuned_model: str) → str[source]¶: Returns a fully-qualified tuned_model string.

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns: The universe domain used by the client instance.
Return type: str

update_permission(request: Optional[Union[google.ai.generativelanguage_v1beta3.types.permission_service.UpdatePermissionRequest, dict]] = None, *, permission: Optional[google.ai.generativelanguage_v1beta3.types.permission.Permission] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.ai.generativelanguage_v1beta3.types.permission.Permission[source]¶

Updates the permission.

# 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.ai import generativelanguage_v1beta3

def sample_update_permission():
    # Create a client
    client = generativelanguage_v1beta3.PermissionServiceClient()

    # Initialize request argument(s)
    request = generativelanguage_v1beta3.UpdatePermissionRequest(
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ai.generativelanguage_v1beta3.types.UpdatePermissionRequest, dict]) – The request object. Request to update the Permission.
permission (google.ai.generativelanguage_v1beta3.types.Permission) –
Required. The permission to update.

The permission’s name field is used to identify the permission to update.

This corresponds to the permission field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Required. The list of fields to update. Accepted ones:
- role (Permission.role field)
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

Permission resource grants user, group or the rest of the world access to the PaLM API resource (e.g. a tuned model, file).

A role is a collection of permitted operations that allows users to perform specific actions on PaLM API resources. To make them available to users, groups, or service accounts, you assign roles. When you assign a role, you grant permissions that the role contains.

There are three concentric roles. Each role is a superset of the previous role’s permitted operations:

reader can use the resource (e.g. tuned model) for inference
writer has reader’s permissions and additionally can edit and share
owner has writer’s permissions and additionally can delete

Return type

google.ai.generativelanguage_v1beta3.types.Permission

class google.ai.generativelanguage_v1beta3.services.permission_service.pagers.ListPermissionsAsyncPager(method: Callable[[...], Awaitable[google.ai.generativelanguage_v1beta3.types.permission_service.ListPermissionsResponse]], request: google.ai.generativelanguage_v1beta3.types.permission_service.ListPermissionsRequest, response: google.ai.generativelanguage_v1beta3.types.permission_service.ListPermissionsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_permissions requests.

This class thinly wraps an initial google.ai.generativelanguage_v1beta3.types.ListPermissionsResponse object, and provides an __aiter__ method to iterate through its permissions field.

If there are more pages, the __aiter__ method will make additional ListPermissions requests and continue to iterate through the permissions field on the corresponding responses.

All the usual google.ai.generativelanguage_v1beta3.types.ListPermissionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.ai.generativelanguage_v1beta3.types.ListPermissionsRequest) – The initial request object.
response (google.ai.generativelanguage_v1beta3.types.ListPermissionsResponse) – The initial response object.
retry (google.api_core.retry.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.

class google.ai.generativelanguage_v1beta3.services.permission_service.pagers.ListPermissionsPager(method: Callable[[...], google.ai.generativelanguage_v1beta3.types.permission_service.ListPermissionsResponse], request: google.ai.generativelanguage_v1beta3.types.permission_service.ListPermissionsRequest, response: google.ai.generativelanguage_v1beta3.types.permission_service.ListPermissionsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_permissions requests.

This class thinly wraps an initial google.ai.generativelanguage_v1beta3.types.ListPermissionsResponse object, and provides an __iter__ method to iterate through its permissions field.

If there are more pages, the __iter__ method will make additional ListPermissions requests and continue to iterate through the permissions field on the corresponding responses.

All the usual google.ai.generativelanguage_v1beta3.types.ListPermissionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.ai.generativelanguage_v1beta3.types.ListPermissionsRequest) – The initial request object.
response (google.ai.generativelanguage_v1beta3.types.ListPermissionsResponse) – The initial response object.
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.

PermissionService¶

google-ai-generativelanguage

Navigation

Related Topics