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.

RegistrationService

class google.cloud.servicedirectory_v1beta1.services.registration_service.RegistrationServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.servicedirectory_v1beta1.services.registration_service.transports.base.RegistrationServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

Service Directory API for registering services. It defines the following resource model:

  • The API has a collection of [Namespace][google.cloud.servicedirectory.v1beta1.Namespace] resources, named projects/*/locations/*/namespaces/*.

  • Each Namespace has a collection of [Service][google.cloud.servicedirectory.v1beta1.Service] resources, named projects/*/locations/*/namespaces/*/services/*.

  • Each Service has a collection of [Endpoint][google.cloud.servicedirectory.v1beta1.Endpoint] resources, named projects/*/locations/*/namespaces/*/services/*/endpoints/*.

Instantiates the registration 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 (Union[str, RegistrationServiceTransport]) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options (ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

Raises

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

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_endpoint(request: Optional[google.cloud.servicedirectory_v1beta1.types.registration_service.CreateEndpointRequest] = None, *, parent: Optional[str] = None, endpoint: Optional[google.cloud.servicedirectory_v1beta1.types.endpoint.Endpoint] = None, endpoint_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.servicedirectory_v1beta1.types.endpoint.Endpoint[source]

Creates an endpoint, and returns the new endpoint.

Parameters
  • request (google.cloud.servicedirectory_v1beta1.types.CreateEndpointRequest) – The request object. The request message for [RegistrationService.CreateEndpoint][google.cloud.servicedirectory.v1beta1.RegistrationService.CreateEndpoint].

  • parent (str) –

    Required. The resource name of the service that this endpoint provides.

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

  • endpoint (google.cloud.servicedirectory_v1beta1.types.Endpoint) –

    Required. A endpoint with initial fields set.

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

  • endpoint_id (str) –

    Required. The Resource ID must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z](?:[-a-z0-9]{0,61}[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

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

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An individual endpoint that provides a

[service][google.cloud.servicedirectory.v1beta1.Service]. The service must already exist to create an endpoint.

Return type

google.cloud.servicedirectory_v1beta1.types.Endpoint

async create_namespace(request: Optional[google.cloud.servicedirectory_v1beta1.types.registration_service.CreateNamespaceRequest] = None, *, parent: Optional[str] = None, namespace: Optional[google.cloud.servicedirectory_v1beta1.types.namespace.Namespace] = None, namespace_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.servicedirectory_v1beta1.types.namespace.Namespace[source]

Creates a namespace, and returns the new namespace.

Parameters
  • request (google.cloud.servicedirectory_v1beta1.types.CreateNamespaceRequest) – The request object. The request message for [RegistrationService.CreateNamespace][google.cloud.servicedirectory.v1beta1.RegistrationService.CreateNamespace].

  • parent (str) –

    Required. The resource name of the project and location the namespace will be created in.

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

  • namespace (google.cloud.servicedirectory_v1beta1.types.Namespace) –

    Required. A namespace with initial fields set.

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

  • namespace_id (str) –

    Required. The Resource ID must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z](?:[-a-z0-9]{0,61}[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

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

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A container for [services][google.cloud.servicedirectory.v1beta1.Service].

Namespaces allow administrators to group services together and define permissions for a collection of services.

Return type

google.cloud.servicedirectory_v1beta1.types.Namespace

async create_service(request: Optional[google.cloud.servicedirectory_v1beta1.types.registration_service.CreateServiceRequest] = None, *, parent: Optional[str] = None, service: Optional[google.cloud.servicedirectory_v1beta1.types.service.Service] = None, service_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.servicedirectory_v1beta1.types.service.Service[source]

Creates a service, and returns the new service.

Parameters
  • request (google.cloud.servicedirectory_v1beta1.types.CreateServiceRequest) – The request object. The request message for [RegistrationService.CreateService][google.cloud.servicedirectory.v1beta1.RegistrationService.CreateService].

  • parent (str) –

    Required. The resource name of the namespace this service will belong to.

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

  • service (google.cloud.servicedirectory_v1beta1.types.Service) –

    Required. A service with initial fields set.

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

  • service_id (str) –

    Required. The Resource ID must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z](?:[-a-z0-9]{0,61}[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

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

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An individual service. A service contains a name and optional metadata.

A service must exist before [endpoints][google.cloud.servicedirectory.v1beta1.Endpoint] can be added to it.

Return type

google.cloud.servicedirectory_v1beta1.types.Service

async delete_endpoint(request: Optional[google.cloud.servicedirectory_v1beta1.types.registration_service.DeleteEndpointRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())None[source]

Deletes an endpoint.

Parameters
  • request (google.cloud.servicedirectory_v1beta1.types.DeleteEndpointRequest) – The request object. The request message for [RegistrationService.DeleteEndpoint][google.cloud.servicedirectory.v1beta1.RegistrationService.DeleteEndpoint].

  • name (str) –

    Required. The name of the endpoint to delete.

    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.

async delete_namespace(request: Optional[google.cloud.servicedirectory_v1beta1.types.registration_service.DeleteNamespaceRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())None[source]

Deletes a namespace. This also deletes all services and endpoints in the namespace.

Parameters
  • request (google.cloud.servicedirectory_v1beta1.types.DeleteNamespaceRequest) – The request object. The request message for [RegistrationService.DeleteNamespace][google.cloud.servicedirectory.v1beta1.RegistrationService.DeleteNamespace].

  • name (str) –

    Required. The name of the namespace to delete.

    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.

async delete_service(request: Optional[google.cloud.servicedirectory_v1beta1.types.registration_service.DeleteServiceRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())None[source]

Deletes a service. This also deletes all endpoints associated with the service.

Parameters
  • request (google.cloud.servicedirectory_v1beta1.types.DeleteServiceRequest) – The request object. The request message for [RegistrationService.DeleteService][google.cloud.servicedirectory.v1beta1.RegistrationService.DeleteService].

  • name (str) –

    Required. The name of the service to delete.

    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.

static endpoint_path(project: str, location: str, namespace: str, service: str, endpoint: str)str

Returns a fully-qualified endpoint string.

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

RegistrationServiceAsyncClient

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

RegistrationServiceAsyncClient

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

RegistrationServiceAsyncClient

async get_endpoint(request: Optional[google.cloud.servicedirectory_v1beta1.types.registration_service.GetEndpointRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.servicedirectory_v1beta1.types.endpoint.Endpoint[source]

Gets an endpoint.

Parameters
  • request (google.cloud.servicedirectory_v1beta1.types.GetEndpointRequest) – The request object. The request message for [RegistrationService.GetEndpoint][google.cloud.servicedirectory.v1beta1.RegistrationService.GetEndpoint]. This should not be used to lookup endpoints at runtime. Instead, use the resolve method.

  • name (str) –

    Required. The name of the endpoint to get.

    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

An individual endpoint that provides a

[service][google.cloud.servicedirectory.v1beta1.Service]. The service must already exist to create an endpoint.

Return type

google.cloud.servicedirectory_v1beta1.types.Endpoint

async get_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.iam.v1.policy_pb2.Policy[source]

Gets the IAM Policy for a resource (namespace or service only).

Parameters
  • request (google.iam.v1.iam_policy_pb2.GetIamPolicyRequest) – The request object. Request message for GetIamPolicy method.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Defines an Identity and Access Management (IAM) policy. It is used to

specify access control policies for Cloud Platform resources.

A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.

JSON Example

{
“bindings”: [
{

“role”: “roles/resourcemanager.organizationAdmin”, “members”: [ “user:mike@example.com”, “group:admins@example.com”, “domain:google.com”, “serviceAccount:my-project-id@appspot.gserviceaccount.com” ]

}, { “role”: “roles/resourcemanager.organizationViewer”, “members”: [“user:eve@example.com”], “condition”: { “title”: “expirable access”, “description”: “Does not grant access after Sep 2020”, “expression”: “request.time < timestamp(‘2020-10-01T00:00:00.000Z’)”, } }

]

}

YAML Example

bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp(‘2020-10-01T00:00:00.000Z’)

For a description of IAM and its features, see the [IAM developer’s guide](https://cloud.google.com/iam/docs).

Return type

google.iam.v1.policy_pb2.Policy

async get_namespace(request: Optional[google.cloud.servicedirectory_v1beta1.types.registration_service.GetNamespaceRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.servicedirectory_v1beta1.types.namespace.Namespace[source]

Gets a namespace.

Parameters
  • request (google.cloud.servicedirectory_v1beta1.types.GetNamespaceRequest) – The request object. The request message for [RegistrationService.GetNamespace][google.cloud.servicedirectory.v1beta1.RegistrationService.GetNamespace].

  • name (str) –

    Required. The name of the namespace to retrieve.

    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

A container for [services][google.cloud.servicedirectory.v1beta1.Service].

Namespaces allow administrators to group services together and define permissions for a collection of services.

Return type

google.cloud.servicedirectory_v1beta1.types.Namespace

async get_service(request: Optional[google.cloud.servicedirectory_v1beta1.types.registration_service.GetServiceRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.servicedirectory_v1beta1.types.service.Service[source]

Gets a service.

Parameters
  • request (google.cloud.servicedirectory_v1beta1.types.GetServiceRequest) – The request object. The request message for [RegistrationService.GetService][google.cloud.servicedirectory.v1beta1.RegistrationService.GetService]. This should not be used for looking up a service. Insead, use the resolve method as it contains all endpoints and associated metadata.

  • name (str) –

    Required. The name of the service to get.

    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

An individual service. A service contains a name and optional metadata.

A service must exist before [endpoints][google.cloud.servicedirectory.v1beta1.Endpoint] can be added to it.

Return type

google.cloud.servicedirectory_v1beta1.types.Service

get_transport_class()Type[google.cloud.servicedirectory_v1beta1.services.registration_service.transports.base.RegistrationServiceTransport]

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_endpoints(request: Optional[google.cloud.servicedirectory_v1beta1.types.registration_service.ListEndpointsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.servicedirectory_v1beta1.services.registration_service.pagers.ListEndpointsAsyncPager[source]

Lists all endpoints.

Parameters
  • request (google.cloud.servicedirectory_v1beta1.types.ListEndpointsRequest) – The request object. The request message for [RegistrationService.ListEndpoints][google.cloud.servicedirectory.v1beta1.RegistrationService.ListEndpoints].

  • parent (str) –

    Required. The resource name of the service whose endpoints you’d like to list.

    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

The response message for [RegistrationService.ListEndpoints][google.cloud.servicedirectory.v1beta1.RegistrationService.ListEndpoints].

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

Return type

google.cloud.servicedirectory_v1beta1.services.registration_service.pagers.ListEndpointsAsyncPager

async list_namespaces(request: Optional[google.cloud.servicedirectory_v1beta1.types.registration_service.ListNamespacesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.servicedirectory_v1beta1.services.registration_service.pagers.ListNamespacesAsyncPager[source]

Lists all namespaces.

Parameters
  • request (google.cloud.servicedirectory_v1beta1.types.ListNamespacesRequest) – The request object. The request message for [RegistrationService.ListNamespaces][google.cloud.servicedirectory.v1beta1.RegistrationService.ListNamespaces].

  • parent (str) –

    Required. The resource name of the project and location whose namespaces you’d like to list.

    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

The response message for [RegistrationService.ListNamespaces][google.cloud.servicedirectory.v1beta1.RegistrationService.ListNamespaces].

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

Return type

google.cloud.servicedirectory_v1beta1.services.registration_service.pagers.ListNamespacesAsyncPager

async list_services(request: Optional[google.cloud.servicedirectory_v1beta1.types.registration_service.ListServicesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.servicedirectory_v1beta1.services.registration_service.pagers.ListServicesAsyncPager[source]

Lists all services belonging to a namespace.

Parameters
  • request (google.cloud.servicedirectory_v1beta1.types.ListServicesRequest) – The request object. The request message for [RegistrationService.ListServices][google.cloud.servicedirectory.v1beta1.RegistrationService.ListServices].

  • parent (str) –

    Required. The resource name of the namespace whose services you’d like to list.

    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

The response message for [RegistrationService.ListServices][google.cloud.servicedirectory.v1beta1.RegistrationService.ListServices].

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

Return type

google.cloud.servicedirectory_v1beta1.services.registration_service.pagers.ListServicesAsyncPager

static namespace_path(project: str, location: str, namespace: str)str

Returns a fully-qualified namespace string.

static network_path(project: str, network: str)str

Returns a fully-qualified network string.

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_endpoint_path(path: str)Dict[str, str]

Parses a endpoint path into its component segments.

static parse_namespace_path(path: str)Dict[str, str]

Parses a namespace path into its component segments.

static parse_network_path(path: str)Dict[str, str]

Parses a network path into its component segments.

static parse_service_path(path: str)Dict[str, str]

Parses a service path into its component segments.

static service_path(project: str, location: str, namespace: str, service: str)str

Returns a fully-qualified service string.

async set_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.iam.v1.policy_pb2.Policy[source]

Sets the IAM Policy for a resource (namespace or service only).

Parameters
  • request (google.iam.v1.iam_policy_pb2.SetIamPolicyRequest) – The request object. Request message for SetIamPolicy method.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Defines an Identity and Access Management (IAM) policy. It is used to

specify access control policies for Cloud Platform resources.

A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.

JSON Example

{
“bindings”: [
{

“role”: “roles/resourcemanager.organizationAdmin”, “members”: [ “user:mike@example.com”, “group:admins@example.com”, “domain:google.com”, “serviceAccount:my-project-id@appspot.gserviceaccount.com” ]

}, { “role”: “roles/resourcemanager.organizationViewer”, “members”: [“user:eve@example.com”], “condition”: { “title”: “expirable access”, “description”: “Does not grant access after Sep 2020”, “expression”: “request.time < timestamp(‘2020-10-01T00:00:00.000Z’)”, } }

]

}

YAML Example

bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp(‘2020-10-01T00:00:00.000Z’)

For a description of IAM and its features, see the [IAM developer’s guide](https://cloud.google.com/iam/docs).

Return type

google.iam.v1.policy_pb2.Policy

async test_iam_permissions(request: Optional[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse[source]

Tests IAM permissions for a resource (namespace or service only).

Parameters
  • request (google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest) – The request object. Request message for TestIamPermissions method.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for TestIamPermissions method.

Return type

google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse

property transport: google.cloud.servicedirectory_v1beta1.services.registration_service.transports.base.RegistrationServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

RegistrationServiceTransport

async update_endpoint(request: Optional[google.cloud.servicedirectory_v1beta1.types.registration_service.UpdateEndpointRequest] = None, *, endpoint: Optional[google.cloud.servicedirectory_v1beta1.types.endpoint.Endpoint] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.servicedirectory_v1beta1.types.endpoint.Endpoint[source]

Updates an endpoint.

Parameters
Returns

An individual endpoint that provides a

[service][google.cloud.servicedirectory.v1beta1.Service]. The service must already exist to create an endpoint.

Return type

google.cloud.servicedirectory_v1beta1.types.Endpoint

async update_namespace(request: Optional[google.cloud.servicedirectory_v1beta1.types.registration_service.UpdateNamespaceRequest] = None, *, namespace: Optional[google.cloud.servicedirectory_v1beta1.types.namespace.Namespace] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.servicedirectory_v1beta1.types.namespace.Namespace[source]

Updates a namespace.

Parameters
Returns

A container for [services][google.cloud.servicedirectory.v1beta1.Service].

Namespaces allow administrators to group services together and define permissions for a collection of services.

Return type

google.cloud.servicedirectory_v1beta1.types.Namespace

async update_service(request: Optional[google.cloud.servicedirectory_v1beta1.types.registration_service.UpdateServiceRequest] = None, *, service: Optional[google.cloud.servicedirectory_v1beta1.types.service.Service] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.servicedirectory_v1beta1.types.service.Service[source]

Updates a service.

Parameters
Returns

An individual service. A service contains a name and optional metadata.

A service must exist before [endpoints][google.cloud.servicedirectory.v1beta1.Endpoint] can be added to it.

Return type

google.cloud.servicedirectory_v1beta1.types.Service

class google.cloud.servicedirectory_v1beta1.services.registration_service.RegistrationServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.servicedirectory_v1beta1.services.registration_service.transports.base.RegistrationServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

Service Directory API for registering services. It defines the following resource model:

  • The API has a collection of [Namespace][google.cloud.servicedirectory.v1beta1.Namespace] resources, named projects/*/locations/*/namespaces/*.

  • Each Namespace has a collection of [Service][google.cloud.servicedirectory.v1beta1.Service] resources, named projects/*/locations/*/namespaces/*/services/*.

  • Each Service has a collection of [Endpoint][google.cloud.servicedirectory.v1beta1.Endpoint] resources, named projects/*/locations/*/namespaces/*/services/*/endpoints/*.

Instantiates the registration 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 (Union[str, RegistrationServiceTransport]) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

  • 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!

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_endpoint(request: Optional[Union[google.cloud.servicedirectory_v1beta1.types.registration_service.CreateEndpointRequest, dict]] = None, *, parent: Optional[str] = None, endpoint: Optional[google.cloud.servicedirectory_v1beta1.types.endpoint.Endpoint] = None, endpoint_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.servicedirectory_v1beta1.types.endpoint.Endpoint[source]

Creates an endpoint, and returns the new endpoint.

Parameters
  • request (Union[google.cloud.servicedirectory_v1beta1.types.CreateEndpointRequest, dict]) – The request object. The request message for [RegistrationService.CreateEndpoint][google.cloud.servicedirectory.v1beta1.RegistrationService.CreateEndpoint].

  • parent (str) –

    Required. The resource name of the service that this endpoint provides.

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

  • endpoint (google.cloud.servicedirectory_v1beta1.types.Endpoint) –

    Required. A endpoint with initial fields set.

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

  • endpoint_id (str) –

    Required. The Resource ID must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z](?:[-a-z0-9]{0,61}[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

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

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An individual endpoint that provides a

[service][google.cloud.servicedirectory.v1beta1.Service]. The service must already exist to create an endpoint.

Return type

google.cloud.servicedirectory_v1beta1.types.Endpoint

create_namespace(request: Optional[Union[google.cloud.servicedirectory_v1beta1.types.registration_service.CreateNamespaceRequest, dict]] = None, *, parent: Optional[str] = None, namespace: Optional[google.cloud.servicedirectory_v1beta1.types.namespace.Namespace] = None, namespace_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.servicedirectory_v1beta1.types.namespace.Namespace[source]

Creates a namespace, and returns the new namespace.

Parameters
  • request (Union[google.cloud.servicedirectory_v1beta1.types.CreateNamespaceRequest, dict]) – The request object. The request message for [RegistrationService.CreateNamespace][google.cloud.servicedirectory.v1beta1.RegistrationService.CreateNamespace].

  • parent (str) –

    Required. The resource name of the project and location the namespace will be created in.

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

  • namespace (google.cloud.servicedirectory_v1beta1.types.Namespace) –

    Required. A namespace with initial fields set.

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

  • namespace_id (str) –

    Required. The Resource ID must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z](?:[-a-z0-9]{0,61}[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

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

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A container for [services][google.cloud.servicedirectory.v1beta1.Service].

Namespaces allow administrators to group services together and define permissions for a collection of services.

Return type

google.cloud.servicedirectory_v1beta1.types.Namespace

create_service(request: Optional[Union[google.cloud.servicedirectory_v1beta1.types.registration_service.CreateServiceRequest, dict]] = None, *, parent: Optional[str] = None, service: Optional[google.cloud.servicedirectory_v1beta1.types.service.Service] = None, service_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.servicedirectory_v1beta1.types.service.Service[source]

Creates a service, and returns the new service.

Parameters
  • request (Union[google.cloud.servicedirectory_v1beta1.types.CreateServiceRequest, dict]) – The request object. The request message for [RegistrationService.CreateService][google.cloud.servicedirectory.v1beta1.RegistrationService.CreateService].

  • parent (str) –

    Required. The resource name of the namespace this service will belong to.

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

  • service (google.cloud.servicedirectory_v1beta1.types.Service) –

    Required. A service with initial fields set.

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

  • service_id (str) –

    Required. The Resource ID must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z](?:[-a-z0-9]{0,61}[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

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

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An individual service. A service contains a name and optional metadata.

A service must exist before [endpoints][google.cloud.servicedirectory.v1beta1.Endpoint] can be added to it.

Return type

google.cloud.servicedirectory_v1beta1.types.Service

delete_endpoint(request: Optional[Union[google.cloud.servicedirectory_v1beta1.types.registration_service.DeleteEndpointRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())None[source]

Deletes an endpoint.

Parameters
  • request (Union[google.cloud.servicedirectory_v1beta1.types.DeleteEndpointRequest, dict]) – The request object. The request message for [RegistrationService.DeleteEndpoint][google.cloud.servicedirectory.v1beta1.RegistrationService.DeleteEndpoint].

  • name (str) –

    Required. The name of the endpoint to delete.

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

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

delete_namespace(request: Optional[Union[google.cloud.servicedirectory_v1beta1.types.registration_service.DeleteNamespaceRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())None[source]

Deletes a namespace. This also deletes all services and endpoints in the namespace.

Parameters
  • request (Union[google.cloud.servicedirectory_v1beta1.types.DeleteNamespaceRequest, dict]) – The request object. The request message for [RegistrationService.DeleteNamespace][google.cloud.servicedirectory.v1beta1.RegistrationService.DeleteNamespace].

  • name (str) –

    Required. The name of the namespace to delete.

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

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

delete_service(request: Optional[Union[google.cloud.servicedirectory_v1beta1.types.registration_service.DeleteServiceRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())None[source]

Deletes a service. This also deletes all endpoints associated with the service.

Parameters
  • request (Union[google.cloud.servicedirectory_v1beta1.types.DeleteServiceRequest, dict]) – The request object. The request message for [RegistrationService.DeleteService][google.cloud.servicedirectory.v1beta1.RegistrationService.DeleteService].

  • name (str) –

    Required. The name of the service to delete.

    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.

static endpoint_path(project: str, location: str, namespace: str, service: str, endpoint: str)str[source]

Returns a fully-qualified endpoint string.

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

RegistrationServiceClient

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

RegistrationServiceClient

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

RegistrationServiceClient

get_endpoint(request: Optional[Union[google.cloud.servicedirectory_v1beta1.types.registration_service.GetEndpointRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.servicedirectory_v1beta1.types.endpoint.Endpoint[source]

Gets an endpoint.

Parameters
  • request (Union[google.cloud.servicedirectory_v1beta1.types.GetEndpointRequest, dict]) – The request object. The request message for [RegistrationService.GetEndpoint][google.cloud.servicedirectory.v1beta1.RegistrationService.GetEndpoint]. This should not be used to lookup endpoints at runtime. Instead, use the resolve method.

  • name (str) –

    Required. The name of the endpoint to get.

    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

An individual endpoint that provides a

[service][google.cloud.servicedirectory.v1beta1.Service]. The service must already exist to create an endpoint.

Return type

google.cloud.servicedirectory_v1beta1.types.Endpoint

get_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.iam.v1.policy_pb2.Policy[source]

Gets the IAM Policy for a resource (namespace or service only).

Parameters
  • request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]) – The request object. Request message for GetIamPolicy method.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Defines an Identity and Access Management (IAM) policy. It is used to

specify access control policies for Cloud Platform resources.

A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.

JSON Example

{
“bindings”: [
{

“role”: “roles/resourcemanager.organizationAdmin”, “members”: [ “user:mike@example.com”, “group:admins@example.com”, “domain:google.com”, “serviceAccount:my-project-id@appspot.gserviceaccount.com” ]

}, { “role”: “roles/resourcemanager.organizationViewer”, “members”: [“user:eve@example.com”], “condition”: { “title”: “expirable access”, “description”: “Does not grant access after Sep 2020”, “expression”: “request.time < timestamp(‘2020-10-01T00:00:00.000Z’)”, } }

]

}

YAML Example

bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp(‘2020-10-01T00:00:00.000Z’)

For a description of IAM and its features, see the [IAM developer’s guide](https://cloud.google.com/iam/docs).

Return type

google.iam.v1.policy_pb2.Policy

get_namespace(request: Optional[Union[google.cloud.servicedirectory_v1beta1.types.registration_service.GetNamespaceRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.servicedirectory_v1beta1.types.namespace.Namespace[source]

Gets a namespace.

Parameters
  • request (Union[google.cloud.servicedirectory_v1beta1.types.GetNamespaceRequest, dict]) – The request object. The request message for [RegistrationService.GetNamespace][google.cloud.servicedirectory.v1beta1.RegistrationService.GetNamespace].

  • name (str) –

    Required. The name of the namespace to retrieve.

    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

A container for [services][google.cloud.servicedirectory.v1beta1.Service].

Namespaces allow administrators to group services together and define permissions for a collection of services.

Return type

google.cloud.servicedirectory_v1beta1.types.Namespace

get_service(request: Optional[Union[google.cloud.servicedirectory_v1beta1.types.registration_service.GetServiceRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.servicedirectory_v1beta1.types.service.Service[source]

Gets a service.

Parameters
  • request (Union[google.cloud.servicedirectory_v1beta1.types.GetServiceRequest, dict]) – The request object. The request message for [RegistrationService.GetService][google.cloud.servicedirectory.v1beta1.RegistrationService.GetService]. This should not be used for looking up a service. Insead, use the resolve method as it contains all endpoints and associated metadata.

  • name (str) –

    Required. The name of the service to get.

    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

An individual service. A service contains a name and optional metadata.

A service must exist before [endpoints][google.cloud.servicedirectory.v1beta1.Endpoint] can be added to it.

Return type

google.cloud.servicedirectory_v1beta1.types.Service

list_endpoints(request: Optional[Union[google.cloud.servicedirectory_v1beta1.types.registration_service.ListEndpointsRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.servicedirectory_v1beta1.services.registration_service.pagers.ListEndpointsPager[source]

Lists all endpoints.

Parameters
  • request (Union[google.cloud.servicedirectory_v1beta1.types.ListEndpointsRequest, dict]) – The request object. The request message for [RegistrationService.ListEndpoints][google.cloud.servicedirectory.v1beta1.RegistrationService.ListEndpoints].

  • parent (str) –

    Required. The resource name of the service whose endpoints you’d like to list.

    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

The response message for [RegistrationService.ListEndpoints][google.cloud.servicedirectory.v1beta1.RegistrationService.ListEndpoints].

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

Return type

google.cloud.servicedirectory_v1beta1.services.registration_service.pagers.ListEndpointsPager

list_namespaces(request: Optional[Union[google.cloud.servicedirectory_v1beta1.types.registration_service.ListNamespacesRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.servicedirectory_v1beta1.services.registration_service.pagers.ListNamespacesPager[source]

Lists all namespaces.

Parameters
  • request (Union[google.cloud.servicedirectory_v1beta1.types.ListNamespacesRequest, dict]) – The request object. The request message for [RegistrationService.ListNamespaces][google.cloud.servicedirectory.v1beta1.RegistrationService.ListNamespaces].

  • parent (str) –

    Required. The resource name of the project and location whose namespaces you’d like to list.

    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

The response message for [RegistrationService.ListNamespaces][google.cloud.servicedirectory.v1beta1.RegistrationService.ListNamespaces].

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

Return type

google.cloud.servicedirectory_v1beta1.services.registration_service.pagers.ListNamespacesPager

list_services(request: Optional[Union[google.cloud.servicedirectory_v1beta1.types.registration_service.ListServicesRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.servicedirectory_v1beta1.services.registration_service.pagers.ListServicesPager[source]

Lists all services belonging to a namespace.

Parameters
  • request (Union[google.cloud.servicedirectory_v1beta1.types.ListServicesRequest, dict]) – The request object. The request message for [RegistrationService.ListServices][google.cloud.servicedirectory.v1beta1.RegistrationService.ListServices].

  • parent (str) –

    Required. The resource name of the namespace whose services you’d like to list.

    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

The response message for [RegistrationService.ListServices][google.cloud.servicedirectory.v1beta1.RegistrationService.ListServices].

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

Return type

google.cloud.servicedirectory_v1beta1.services.registration_service.pagers.ListServicesPager

static namespace_path(project: str, location: str, namespace: str)str[source]

Returns a fully-qualified namespace string.

static network_path(project: str, network: str)str[source]

Returns a fully-qualified network string.

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_endpoint_path(path: str)Dict[str, str][source]

Parses a endpoint path into its component segments.

static parse_namespace_path(path: str)Dict[str, str][source]

Parses a namespace path into its component segments.

static parse_network_path(path: str)Dict[str, str][source]

Parses a network path into its component segments.

static parse_service_path(path: str)Dict[str, str][source]

Parses a service path into its component segments.

static service_path(project: str, location: str, namespace: str, service: str)str[source]

Returns a fully-qualified service string.

set_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.iam.v1.policy_pb2.Policy[source]

Sets the IAM Policy for a resource (namespace or service only).

Parameters
  • request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]) – The request object. Request message for SetIamPolicy method.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Defines an Identity and Access Management (IAM) policy. It is used to

specify access control policies for Cloud Platform resources.

A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.

JSON Example

{
“bindings”: [
{

“role”: “roles/resourcemanager.organizationAdmin”, “members”: [ “user:mike@example.com”, “group:admins@example.com”, “domain:google.com”, “serviceAccount:my-project-id@appspot.gserviceaccount.com” ]

}, { “role”: “roles/resourcemanager.organizationViewer”, “members”: [“user:eve@example.com”], “condition”: { “title”: “expirable access”, “description”: “Does not grant access after Sep 2020”, “expression”: “request.time < timestamp(‘2020-10-01T00:00:00.000Z’)”, } }

]

}

YAML Example

bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp(‘2020-10-01T00:00:00.000Z’)

For a description of IAM and its features, see the [IAM developer’s guide](https://cloud.google.com/iam/docs).

Return type

google.iam.v1.policy_pb2.Policy

test_iam_permissions(request: Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse[source]

Tests IAM permissions for a resource (namespace or service only).

Parameters
  • request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]) – The request object. Request message for TestIamPermissions method.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for TestIamPermissions method.

Return type

google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse

property transport: google.cloud.servicedirectory_v1beta1.services.registration_service.transports.base.RegistrationServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

RegistrationServiceTransport

update_endpoint(request: Optional[Union[google.cloud.servicedirectory_v1beta1.types.registration_service.UpdateEndpointRequest, dict]] = None, *, endpoint: Optional[google.cloud.servicedirectory_v1beta1.types.endpoint.Endpoint] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.servicedirectory_v1beta1.types.endpoint.Endpoint[source]

Updates an endpoint.

Parameters
Returns

An individual endpoint that provides a

[service][google.cloud.servicedirectory.v1beta1.Service]. The service must already exist to create an endpoint.

Return type

google.cloud.servicedirectory_v1beta1.types.Endpoint

update_namespace(request: Optional[Union[google.cloud.servicedirectory_v1beta1.types.registration_service.UpdateNamespaceRequest, dict]] = None, *, namespace: Optional[google.cloud.servicedirectory_v1beta1.types.namespace.Namespace] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.servicedirectory_v1beta1.types.namespace.Namespace[source]

Updates a namespace.

Parameters
Returns

A container for [services][google.cloud.servicedirectory.v1beta1.Service].

Namespaces allow administrators to group services together and define permissions for a collection of services.

Return type

google.cloud.servicedirectory_v1beta1.types.Namespace

update_service(request: Optional[Union[google.cloud.servicedirectory_v1beta1.types.registration_service.UpdateServiceRequest, dict]] = None, *, service: Optional[google.cloud.servicedirectory_v1beta1.types.service.Service] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.servicedirectory_v1beta1.types.service.Service[source]

Updates a service.

Parameters
Returns

An individual service. A service contains a name and optional metadata.

A service must exist before [endpoints][google.cloud.servicedirectory.v1beta1.Endpoint] can be added to it.

Return type

google.cloud.servicedirectory_v1beta1.types.Service

class google.cloud.servicedirectory_v1beta1.services.registration_service.pagers.ListEndpointsAsyncPager(method: Callable[[...], Awaitable[google.cloud.servicedirectory_v1beta1.types.registration_service.ListEndpointsResponse]], request: google.cloud.servicedirectory_v1beta1.types.registration_service.ListEndpointsRequest, response: google.cloud.servicedirectory_v1beta1.types.registration_service.ListEndpointsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_endpoints requests.

This class thinly wraps an initial google.cloud.servicedirectory_v1beta1.types.ListEndpointsResponse object, and provides an __aiter__ method to iterate through its endpoints field.

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

All the usual google.cloud.servicedirectory_v1beta1.types.ListEndpointsResponse 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
class google.cloud.servicedirectory_v1beta1.services.registration_service.pagers.ListEndpointsPager(method: Callable[[...], google.cloud.servicedirectory_v1beta1.types.registration_service.ListEndpointsResponse], request: google.cloud.servicedirectory_v1beta1.types.registration_service.ListEndpointsRequest, response: google.cloud.servicedirectory_v1beta1.types.registration_service.ListEndpointsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_endpoints requests.

This class thinly wraps an initial google.cloud.servicedirectory_v1beta1.types.ListEndpointsResponse object, and provides an __iter__ method to iterate through its endpoints field.

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

All the usual google.cloud.servicedirectory_v1beta1.types.ListEndpointsResponse 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
class google.cloud.servicedirectory_v1beta1.services.registration_service.pagers.ListNamespacesAsyncPager(method: Callable[[...], Awaitable[google.cloud.servicedirectory_v1beta1.types.registration_service.ListNamespacesResponse]], request: google.cloud.servicedirectory_v1beta1.types.registration_service.ListNamespacesRequest, response: google.cloud.servicedirectory_v1beta1.types.registration_service.ListNamespacesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_namespaces requests.

This class thinly wraps an initial google.cloud.servicedirectory_v1beta1.types.ListNamespacesResponse object, and provides an __aiter__ method to iterate through its namespaces field.

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

All the usual google.cloud.servicedirectory_v1beta1.types.ListNamespacesResponse 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
class google.cloud.servicedirectory_v1beta1.services.registration_service.pagers.ListNamespacesPager(method: Callable[[...], google.cloud.servicedirectory_v1beta1.types.registration_service.ListNamespacesResponse], request: google.cloud.servicedirectory_v1beta1.types.registration_service.ListNamespacesRequest, response: google.cloud.servicedirectory_v1beta1.types.registration_service.ListNamespacesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_namespaces requests.

This class thinly wraps an initial google.cloud.servicedirectory_v1beta1.types.ListNamespacesResponse object, and provides an __iter__ method to iterate through its namespaces field.

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

All the usual google.cloud.servicedirectory_v1beta1.types.ListNamespacesResponse 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
class google.cloud.servicedirectory_v1beta1.services.registration_service.pagers.ListServicesAsyncPager(method: Callable[[...], Awaitable[google.cloud.servicedirectory_v1beta1.types.registration_service.ListServicesResponse]], request: google.cloud.servicedirectory_v1beta1.types.registration_service.ListServicesRequest, response: google.cloud.servicedirectory_v1beta1.types.registration_service.ListServicesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_services requests.

This class thinly wraps an initial google.cloud.servicedirectory_v1beta1.types.ListServicesResponse object, and provides an __aiter__ method to iterate through its services field.

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

All the usual google.cloud.servicedirectory_v1beta1.types.ListServicesResponse 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
class google.cloud.servicedirectory_v1beta1.services.registration_service.pagers.ListServicesPager(method: Callable[[...], google.cloud.servicedirectory_v1beta1.types.registration_service.ListServicesResponse], request: google.cloud.servicedirectory_v1beta1.types.registration_service.ListServicesRequest, response: google.cloud.servicedirectory_v1beta1.types.registration_service.ListServicesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_services requests.

This class thinly wraps an initial google.cloud.servicedirectory_v1beta1.types.ListServicesResponse object, and provides an __iter__ method to iterate through its services field.

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

All the usual google.cloud.servicedirectory_v1beta1.types.ListServicesResponse 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