google.ai.generativelanguage.PermissionServiceClient

Provides methods for managing permissions to PaLM API resources.

google.ai.generativelanguage.PermissionServiceClient(
    *,
    credentials: Optional[ga_credentials.Credentials] = None,
    transport: Optional[Union[str, PermissionServiceTransport]] = None,
    client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None,
    client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO
) -> None

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, PermissionServiceTransport]

The transport to use. 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. 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.

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.

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

transport Returns the transport used by the client instance.

Methods

create_permission

View source

create_permission(
    request: Optional[Union[google.ai.generativelanguage.CreatePermissionRequest, dict]] = None,
    *,
    parent: Optional[str] = None,
    permission: Optional[google.ai.generativelanguage.Permission] = None,
    retry: OptionalRetry = gapic_v1.method.DEFAULT,
    timeout: Union[float, object] = gapic_v1.method.DEFAULT,
    metadata: Sequence[Tuple[str, str]] = ()
) -> google.ai.generativelanguage.Permission

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:
#   <a href="https://googleapis.dev/python/google-api-core/latest/client_options.html">https://googleapis.dev/python/google-api-core/latest/client_options.html</a>
from google.ai import generativelanguage_v1beta

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

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

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

    # Handle the response
    print(response)

Args
request Union[google.ai.generativelanguage.CreatePermissionRequest, dict]

The request object. Request to create a Permission.

parent str

Required. The parent resource of the Permission. Formats: tunedModels/{tuned_model} corpora/{corpus}

This corresponds to the parent field on the request instance; if request is provided, this should not be set.

permission google.ai.generativelanguage.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
google.ai.generativelanguage.Permission Permission resource grants user, group or the rest of the world access to the PaLM API resource (e.g. a tuned model, corpus).

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, corpus) for inference

  • writer has reader's permissions and additionally can edit and share

  • owner has writer's permissions and additionally can delete

delete_permission

View source

delete_permission(
    request: Optional[Union[google.ai.generativelanguage.DeletePermissionRequest, dict]] = None,
    *,
    name: Optional[str] = None,
    retry: OptionalRetry = gapic_v1.method.DEFAULT,
    timeout: Union[float, object] = gapic_v1.method.DEFAULT,
    metadata: Sequence[Tuple[str, str]] = ()
) -> None

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:
#   <a href="https://googleapis.dev/python/google-api-core/latest/client_options.html">https://googleapis.dev/python/google-api-core/latest/client_options.html</a>
from google.ai import generativelanguage_v1beta

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

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

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

Args
request Union[google.ai.generativelanguage.DeletePermissionRequest, dict]

The request object. Request to delete the Permission.

name str

Required. The resource name of the permission. Formats: tunedModels/{tuned_model}/permissions/{permission} corpora/{corpus}/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.

from_service_account_file

View source

@classmethod
from_service_account_file(
    filename: str, *args, **kwargs
)

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

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

from_service_account_info

View source

@classmethod
from_service_account_info(
    info: dict, *args, **kwargs
)

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

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

from_service_account_json

View source

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

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

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

get_mtls_endpoint_and_cert_source

View source

@classmethod
get_mtls_endpoint_and_cert_source(
    client_options: Optional[client_options_lib.ClientOptions] = None
)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114

Args
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
Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the client cert source to use.

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

get_permission

View source

get_permission(
    request: Optional[Union[google.ai.generativelanguage.GetPermissionRequest, dict]] = None,
    *,
    name: Optional[str] = None,
    retry: OptionalRetry = gapic_v1.method.DEFAULT,
    timeout: Union[float, object] = gapic_v1.method.DEFAULT,
    metadata: Sequence[Tuple[str, str]] = ()
) -> google.ai.generativelanguage.Permission

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:
#   <a href="https://googleapis.dev/python/google-api-core/latest/client_options.html">https://googleapis.dev/python/google-api-core/latest/client_options.html</a>
from google.ai import generativelanguage_v1beta

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

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

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

    # Handle the response
    print(response)

Args
request Union[google.ai.generativelanguage.GetPermissionRequest, dict]

The request object. Request for getting information about a specific Permission.

name str

Required. The resource name of the permission.

Formats: tunedModels/{tuned_model}/permissions/{permission} corpora/{corpus}/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
google.ai.generativelanguage.Permission Permission resource grants user, group or the rest of the world access to the PaLM API resource (e.g. a tuned model, corpus).

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, corpus) for inference

  • writer has reader's permissions and additionally can edit and share

  • owner has writer's permissions and additionally can delete

list_permissions

View source

list_permissions(
    request: Optional[Union[google.ai.generativelanguage.ListPermissionsRequest, dict]] = None,
    *,
    parent: Optional[str] = None,
    retry: OptionalRetry = gapic_v1.method.DEFAULT,
    timeout: Union[float, object] = gapic_v1.method.DEFAULT,
    metadata: Sequence[Tuple[str, str]] = ()
) -> pagers.ListPermissionsPager

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:
#   <a href="https://googleapis.dev/python/google-api-core/latest/client_options.html">https://googleapis.dev/python/google-api-core/latest/client_options.html</a>
from google.ai import generativelanguage_v1beta

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

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

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

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

Args
request Union[google.ai.generativelanguage.ListPermissionsRequest, dict]

The request object. Request for listing permissions.

parent str

Required. The parent resource of the permissions. Formats: tunedModels/{tuned_model} corpora/{corpus}

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
google.ai.generativelanguage_v1beta.services.permission_service.pagers.ListPermissionsPager Response from ListPermissions containing a paginated list of permissions.

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

transfer_ownership

View source

transfer_ownership(
    request: Optional[Union[google.ai.generativelanguage.TransferOwnershipRequest, dict]] = None,
    *,
    retry: OptionalRetry = gapic_v1.method.DEFAULT,
    timeout: Union[float, object] = gapic_v1.method.DEFAULT,
    metadata: Sequence[Tuple[str, str]] = ()
) -> google.ai.generativelanguage.TransferOwnershipResponse

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:
#   <a href="https://googleapis.dev/python/google-api-core/latest/client_options.html">https://googleapis.dev/python/google-api-core/latest/client_options.html</a>
from google.ai import generativelanguage_v1beta

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

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

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

    # Handle the response
    print(response)

Args
request Union[google.ai.generativelanguage.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
google.ai.generativelanguage.TransferOwnershipResponse Response from TransferOwnership.

update_permission

View source

update_permission(
    request: Optional[Union[google.ai.generativelanguage.UpdatePermissionRequest, dict]] = None,
    *,
    permission: Optional[google.ai.generativelanguage.Permission] = None,
    update_mask: Optional[field_mask_pb2.FieldMask] = None,
    retry: OptionalRetry = gapic_v1.method.DEFAULT,
    timeout: Union[float, object] = gapic_v1.method.DEFAULT,
    metadata: Sequence[Tuple[str, str]] = ()
) -> google.ai.generativelanguage.Permission

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:
#   <a href="https://googleapis.dev/python/google-api-core/latest/client_options.html">https://googleapis.dev/python/google-api-core/latest/client_options.html</a>
from google.ai import generativelanguage_v1beta

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

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

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

    # Handle the response
    print(response)

Args
request Union[google.ai.generativelanguage.UpdatePermissionRequest, dict]

The request object. Request to update the Permission.

permission google.ai.generativelanguage.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:

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
google.ai.generativelanguage.Permission Permission resource grants user, group or the rest of the world access to the PaLM API resource (e.g. a tuned model, corpus).

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, corpus) for inference

  • writer has reader's permissions and additionally can edit and share

  • owner has writer's permissions and additionally can delete

__enter__

View source

__enter__() -> 'PermissionServiceClient'

__exit__

View source

__exit__(
    type, value, traceback
)

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!

DEFAULT_ENDPOINT 'generativelanguage.googleapis.com'
DEFAULT_MTLS_ENDPOINT 'generativelanguage.mtls.googleapis.com'