Summary of entries of Methods for google-cloud-privilegedaccessmanager.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient
PrivilegedAccessManagerAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.transports.base.PrivilegedAccessManagerTransport, typing.Callable[[...], google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.transports.base.PrivilegedAccessManagerTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the privileged access manager async client.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.approve_grant
approve_grant(
request: typing.Optional[
typing.Union[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.ApproveGrantRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.Grant
ApproveGrant
is used to approve a grant.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.check_onboarding_status
check_onboarding_status(
request: typing.Optional[
typing.Union[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.CheckOnboardingStatusRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.CheckOnboardingStatusResponse
)
CheckOnboardingStatus reports the onboarding status for a project/folder/organization.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.create_entitlement
create_entitlement(
request: typing.Optional[
typing.Union[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.CreateEntitlementRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
entitlement: typing.Optional[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.Entitlement
] = None,
entitlement_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new entitlement in a given project/folder/organization and location.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.create_grant
create_grant(
request: typing.Optional[
typing.Union[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.CreateGrantRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
grant: typing.Optional[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.Grant
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.Grant
Creates a new grant in a given project and location.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.delete_entitlement
delete_entitlement(
request: typing.Optional[
typing.Union[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.DeleteEntitlementRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single entitlement.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.deny_grant
deny_grant(
request: typing.Optional[
typing.Union[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.DenyGrantRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.Grant
DenyGrant
is used to deny a grant.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.entitlement_path
entitlement_path(project: str, location: str, entitlement: str) -> str
Returns a fully-qualified entitlement string.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.get_entitlement
get_entitlement(
request: typing.Optional[
typing.Union[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.GetEntitlementRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.Entitlement
Gets details of a single entitlement.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.get_grant
get_grant(
request: typing.Optional[
typing.Union[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.GetGrantRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.Grant
Get details of a single grant.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.transports.base.PrivilegedAccessManagerTransport
]
)
Returns an appropriate transport class.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.grant_path
grant_path(project: str, location: str, entitlement: str, grant: str) -> str
Returns a fully-qualified grant string.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.list_entitlements
list_entitlements(
request: typing.Optional[
typing.Union[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.ListEntitlementsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.pagers.ListEntitlementsAsyncPager
)
Lists entitlements in a given project/folder/organization and location.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.list_grants
list_grants(
request: typing.Optional[
typing.Union[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.ListGrantsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.pagers.ListGrantsAsyncPager
)
Lists grants for a given entitlement.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.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.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.parse_entitlement_path
parse_entitlement_path(path: str) -> typing.Dict[str, str]
Parses a entitlement path into its component segments.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.parse_grant_path
parse_grant_path(path: str) -> typing.Dict[str, str]
Parses a grant path into its component segments.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.revoke_grant
revoke_grant(
request: typing.Optional[
typing.Union[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.RevokeGrantRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
RevokeGrant
is used to immediately revoke access for a
grant.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.search_entitlements
search_entitlements(
request: typing.Optional[
typing.Union[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.SearchEntitlementsRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.pagers.SearchEntitlementsAsyncPager
)
SearchEntitlements
returns entitlements on which the caller
has the specified access.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.search_grants
search_grants(
request: typing.Optional[
typing.Union[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.SearchGrantsRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.pagers.SearchGrantsAsyncPager
)
SearchGrants
returns grants that are related to the calling
user in the specified way.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerAsyncClient.update_entitlement
update_entitlement(
request: typing.Optional[
typing.Union[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.UpdateEntitlementRequest,
dict,
]
] = None,
*,
entitlement: typing.Optional[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.Entitlement
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates the entitlement specified in the request.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient
PrivilegedAccessManagerClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.transports.base.PrivilegedAccessManagerTransport, typing.Callable[[...], google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.transports.base.PrivilegedAccessManagerTransport]]] = 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 =
Instantiates the privileged access manager client.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.approve_grant
approve_grant(
request: typing.Optional[
typing.Union[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.ApproveGrantRequest,
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, str]] = ()
) -> google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.Grant
ApproveGrant
is used to approve a grant.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.check_onboarding_status
check_onboarding_status(
request: typing.Optional[
typing.Union[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.CheckOnboardingStatusRequest,
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, str]] = ()
) -> (
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.CheckOnboardingStatusResponse
)
CheckOnboardingStatus reports the onboarding status for a project/folder/organization.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.create_entitlement
create_entitlement(
request: typing.Optional[
typing.Union[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.CreateEntitlementRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
entitlement: typing.Optional[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.Entitlement
] = None,
entitlement_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, str]] = ()
) -> google.api_core.operation.Operation
Creates a new entitlement in a given project/folder/organization and location.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.create_grant
create_grant(
request: typing.Optional[
typing.Union[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.CreateGrantRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
grant: typing.Optional[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.Grant
] = 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, str]] = ()
) -> google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.Grant
Creates a new grant in a given project and location.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.delete_entitlement
delete_entitlement(
request: typing.Optional[
typing.Union[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.DeleteEntitlementRequest,
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, str]] = ()
) -> google.api_core.operation.Operation
Deletes a single entitlement.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = 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, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.deny_grant
deny_grant(
request: typing.Optional[
typing.Union[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.DenyGrantRequest,
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, str]] = ()
) -> google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.Grant
DenyGrant
is used to deny a grant.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.entitlement_path
entitlement_path(project: str, location: str, entitlement: str) -> str
Returns a fully-qualified entitlement string.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.get_entitlement
get_entitlement(
request: typing.Optional[
typing.Union[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.GetEntitlementRequest,
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, str]] = ()
) -> google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.Entitlement
Gets details of a single entitlement.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.get_grant
get_grant(
request: typing.Optional[
typing.Union[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.GetGrantRequest,
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, str]] = ()
) -> google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.Grant
Get details of a single grant.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = 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, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = 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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.grant_path
grant_path(project: str, location: str, entitlement: str, grant: str) -> str
Returns a fully-qualified grant string.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.list_entitlements
list_entitlements(
request: typing.Optional[
typing.Union[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.ListEntitlementsRequest,
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, str]] = ()
) -> (
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.pagers.ListEntitlementsPager
)
Lists entitlements in a given project/folder/organization and location.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.list_grants
list_grants(
request: typing.Optional[
typing.Union[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.ListGrantsRequest,
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, str]] = ()
) -> (
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.pagers.ListGrantsPager
)
Lists grants for a given entitlement.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = 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, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = 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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.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.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.parse_entitlement_path
parse_entitlement_path(path: str) -> typing.Dict[str, str]
Parses a entitlement path into its component segments.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.parse_grant_path
parse_grant_path(path: str) -> typing.Dict[str, str]
Parses a grant path into its component segments.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.revoke_grant
revoke_grant(
request: typing.Optional[
typing.Union[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.RevokeGrantRequest,
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, str]] = ()
) -> google.api_core.operation.Operation
RevokeGrant
is used to immediately revoke access for a
grant.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.search_entitlements
search_entitlements(
request: typing.Optional[
typing.Union[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.SearchEntitlementsRequest,
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, str]] = ()
) -> (
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.pagers.SearchEntitlementsPager
)
SearchEntitlements
returns entitlements on which the caller
has the specified access.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.search_grants
search_grants(
request: typing.Optional[
typing.Union[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.SearchGrantsRequest,
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, str]] = ()
) -> (
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.pagers.SearchGrantsPager
)
SearchGrants
returns grants that are related to the calling
user in the specified way.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.PrivilegedAccessManagerClient.update_entitlement
update_entitlement(
request: typing.Optional[
typing.Union[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.UpdateEntitlementRequest,
dict,
]
] = None,
*,
entitlement: typing.Optional[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.Entitlement
] = 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, str]] = ()
) -> google.api_core.operation.Operation
Updates the entitlement specified in the request.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.pagers.ListEntitlementsAsyncPager
ListEntitlementsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.ListEntitlementsResponse
],
],
request: google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.ListEntitlementsRequest,
response: google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.ListEntitlementsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.pagers.ListEntitlementsPager
ListEntitlementsPager(
method: typing.Callable[
[...],
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.ListEntitlementsResponse,
],
request: google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.ListEntitlementsRequest,
response: google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.ListEntitlementsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.pagers.ListGrantsAsyncPager
ListGrantsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.ListGrantsResponse
],
],
request: google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.ListGrantsRequest,
response: google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.ListGrantsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.pagers.ListGrantsPager
ListGrantsPager(
method: typing.Callable[
[...],
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.ListGrantsResponse,
],
request: google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.ListGrantsRequest,
response: google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.ListGrantsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.pagers.ListGrantsPager
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.pagers.SearchEntitlementsAsyncPager
SearchEntitlementsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.SearchEntitlementsResponse
],
],
request: google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.SearchEntitlementsRequest,
response: google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.SearchEntitlementsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.pagers.SearchEntitlementsPager
SearchEntitlementsPager(
method: typing.Callable[
[...],
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.SearchEntitlementsResponse,
],
request: google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.SearchEntitlementsRequest,
response: google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.SearchEntitlementsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.pagers.SearchGrantsAsyncPager
SearchGrantsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.SearchGrantsResponse
],
],
request: google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.SearchGrantsRequest,
response: google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.SearchGrantsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.pagers.SearchGrantsPager
SearchGrantsPager(
method: typing.Callable[
[...],
google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.SearchGrantsResponse,
],
request: google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.SearchGrantsRequest,
response: google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager.SearchGrantsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager.pagers.SearchGrantsPager