Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ Types for Google Cloud Discoveryengine v1beta API

.. automodule:: google.cloud.discoveryengine_v1beta.types
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,17 @@
from collections import OrderedDict
import functools
import re
from typing import Dict, Mapping, Optional, Sequence, Tuple, Type, Union
from typing import (
Dict,
Mapping,
MutableMapping,
MutableSequence,
Optional,
Sequence,
Tuple,
Type,
Union,
)

from google.api_core import exceptions as core_exceptions
from google.api_core import gapic_v1
Expand Down Expand Up @@ -171,9 +181,9 @@ def transport(self) -> DocumentServiceTransport:
def __init__(
self,
*,
credentials: ga_credentials.Credentials = None,
credentials: Optional[ga_credentials.Credentials] = None,
transport: Union[str, DocumentServiceTransport] = "grpc_asyncio",
client_options: ClientOptions = None,
client_options: Optional[ClientOptions] = None,
client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
) -> None:
"""Instantiates the document service client.
Expand Down Expand Up @@ -217,11 +227,11 @@ def __init__(

async def get_document(
self,
request: Union[document_service.GetDocumentRequest, dict] = None,
request: Optional[Union[document_service.GetDocumentRequest, dict]] = None,
*,
name: str = None,
name: Optional[str] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
timeout: Optional[float] = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> document.Document:
r"""Gets a [Document][google.cloud.discoveryengine.v1beta.Document].
Expand Down Expand Up @@ -253,7 +263,7 @@ async def sample_get_document():
print(response)

Args:
request (Union[google.cloud.discoveryengine_v1beta.types.GetDocumentRequest, dict]):
request (Optional[Union[google.cloud.discoveryengine_v1beta.types.GetDocumentRequest, dict]]):
The request object. Request message for
[DocumentService.GetDocument][google.cloud.discoveryengine.v1beta.DocumentService.GetDocument]
method.
Expand Down Expand Up @@ -332,11 +342,11 @@ async def sample_get_document():

async def list_documents(
self,
request: Union[document_service.ListDocumentsRequest, dict] = None,
request: Optional[Union[document_service.ListDocumentsRequest, dict]] = None,
*,
parent: str = None,
parent: Optional[str] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
timeout: Optional[float] = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListDocumentsAsyncPager:
r"""Gets a list of
Expand Down Expand Up @@ -370,7 +380,7 @@ async def sample_list_documents():
print(response)

Args:
request (Union[google.cloud.discoveryengine_v1beta.types.ListDocumentsRequest, dict]):
request (Optional[Union[google.cloud.discoveryengine_v1beta.types.ListDocumentsRequest, dict]]):
The request object. Request message for
[DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments]
method.
Expand Down Expand Up @@ -457,13 +467,13 @@ async def sample_list_documents():

async def create_document(
self,
request: Union[document_service.CreateDocumentRequest, dict] = None,
request: Optional[Union[document_service.CreateDocumentRequest, dict]] = None,
*,
parent: str = None,
document: gcd_document.Document = None,
document_id: str = None,
parent: Optional[str] = None,
document: Optional[gcd_document.Document] = None,
document_id: Optional[str] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
timeout: Optional[float] = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> gcd_document.Document:
r"""Creates a
Expand Down Expand Up @@ -501,7 +511,7 @@ async def sample_create_document():
print(response)

Args:
request (Union[google.cloud.discoveryengine_v1beta.types.CreateDocumentRequest, dict]):
request (Optional[Union[google.cloud.discoveryengine_v1beta.types.CreateDocumentRequest, dict]]):
The request object. Request message for
[DocumentService.CreateDocument][google.cloud.discoveryengine.v1beta.DocumentService.CreateDocument]
method.
Expand Down Expand Up @@ -606,10 +616,10 @@ async def sample_create_document():

async def update_document(
self,
request: Union[document_service.UpdateDocumentRequest, dict] = None,
request: Optional[Union[document_service.UpdateDocumentRequest, dict]] = None,
*,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
timeout: Optional[float] = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> document.Document:
r"""Updates a
Expand Down Expand Up @@ -645,7 +655,7 @@ async def sample_update_document():
print(response)

Args:
request (Union[google.cloud.discoveryengine_v1beta.types.UpdateDocumentRequest, dict]):
request (Optional[Union[google.cloud.discoveryengine_v1beta.types.UpdateDocumentRequest, dict]]):
The request object. Request message for
[DocumentService.UpdateDocument][google.cloud.discoveryengine.v1beta.DocumentService.UpdateDocument]
method.
Expand Down Expand Up @@ -694,11 +704,11 @@ async def sample_update_document():

async def delete_document(
self,
request: Union[document_service.DeleteDocumentRequest, dict] = None,
request: Optional[Union[document_service.DeleteDocumentRequest, dict]] = None,
*,
name: str = None,
name: Optional[str] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
timeout: Optional[float] = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> None:
r"""Deletes a
Expand Down Expand Up @@ -728,7 +738,7 @@ async def sample_delete_document():
await client.delete_document(request=request)

Args:
request (Union[google.cloud.discoveryengine_v1beta.types.DeleteDocumentRequest, dict]):
request (Optional[Union[google.cloud.discoveryengine_v1beta.types.DeleteDocumentRequest, dict]]):
The request object. Request message for
[DocumentService.DeleteDocument][google.cloud.discoveryengine.v1beta.DocumentService.DeleteDocument]
method.
Expand Down Expand Up @@ -797,10 +807,10 @@ async def sample_delete_document():

async def import_documents(
self,
request: Union[import_config.ImportDocumentsRequest, dict] = None,
request: Optional[Union[import_config.ImportDocumentsRequest, dict]] = None,
*,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
timeout: Optional[float] = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> operation_async.AsyncOperation:
r"""Bulk import of multiple
Expand Down Expand Up @@ -847,7 +857,7 @@ async def sample_import_documents():
print(response)

Args:
request (Union[google.cloud.discoveryengine_v1beta.types.ImportDocumentsRequest, dict]):
request (Optional[Union[google.cloud.discoveryengine_v1beta.types.ImportDocumentsRequest, dict]]):
The request object. Request message for Import methods.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
Expand Down Expand Up @@ -914,10 +924,10 @@ async def sample_import_documents():

async def list_operations(
self,
request: operations_pb2.ListOperationsRequest = None,
request: Optional[operations_pb2.ListOperationsRequest] = None,
*,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
timeout: Optional[float] = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> operations_pb2.ListOperationsResponse:
r"""Lists operations that match the specified filter in the request.
Expand Down Expand Up @@ -968,10 +978,10 @@ async def list_operations(

async def get_operation(
self,
request: operations_pb2.GetOperationRequest = None,
request: Optional[operations_pb2.GetOperationRequest] = None,
*,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
timeout: Optional[float] = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> operations_pb2.Operation:
r"""Gets the latest state of a long-running operation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,18 @@
from collections import OrderedDict
import os
import re
from typing import Dict, Mapping, Optional, Sequence, Tuple, Type, Union, cast
from typing import (
Dict,
Mapping,
MutableMapping,
MutableSequence,
Optional,
Sequence,
Tuple,
Type,
Union,
cast,
)

from google.api_core import client_options as client_options_lib
from google.api_core import exceptions as core_exceptions
Expand Down Expand Up @@ -67,7 +78,7 @@ class DocumentServiceClientMeta(type):

def get_transport_class(
cls,
label: str = None,
label: Optional[str] = None,
) -> Type[DocumentServiceTransport]:
"""Returns an appropriate transport class.

Expand Down Expand Up @@ -373,7 +384,7 @@ def __init__(
self,
*,
credentials: Optional[ga_credentials.Credentials] = None,
transport: Union[str, DocumentServiceTransport, None] = None,
transport: Optional[Union[str, DocumentServiceTransport]] = None,
client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None,
client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
) -> None:
Expand Down Expand Up @@ -474,11 +485,11 @@ def __init__(

def get_document(
self,
request: Union[document_service.GetDocumentRequest, dict] = None,
request: Optional[Union[document_service.GetDocumentRequest, dict]] = None,
*,
name: str = None,
name: Optional[str] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
timeout: Optional[float] = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> document.Document:
r"""Gets a [Document][google.cloud.discoveryengine.v1beta.Document].
Expand Down Expand Up @@ -589,11 +600,11 @@ def sample_get_document():

def list_documents(
self,
request: Union[document_service.ListDocumentsRequest, dict] = None,
request: Optional[Union[document_service.ListDocumentsRequest, dict]] = None,
*,
parent: str = None,
parent: Optional[str] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
timeout: Optional[float] = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListDocumentsPager:
r"""Gets a list of
Expand Down Expand Up @@ -714,13 +725,13 @@ def sample_list_documents():

def create_document(
self,
request: Union[document_service.CreateDocumentRequest, dict] = None,
request: Optional[Union[document_service.CreateDocumentRequest, dict]] = None,
*,
parent: str = None,
document: gcd_document.Document = None,
document_id: str = None,
parent: Optional[str] = None,
document: Optional[gcd_document.Document] = None,
document_id: Optional[str] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
timeout: Optional[float] = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> gcd_document.Document:
r"""Creates a
Expand Down Expand Up @@ -863,10 +874,10 @@ def sample_create_document():

def update_document(
self,
request: Union[document_service.UpdateDocumentRequest, dict] = None,
request: Optional[Union[document_service.UpdateDocumentRequest, dict]] = None,
*,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
timeout: Optional[float] = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> document.Document:
r"""Updates a
Expand Down Expand Up @@ -952,11 +963,11 @@ def sample_update_document():

def delete_document(
self,
request: Union[document_service.DeleteDocumentRequest, dict] = None,
request: Optional[Union[document_service.DeleteDocumentRequest, dict]] = None,
*,
name: str = None,
name: Optional[str] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
timeout: Optional[float] = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> None:
r"""Deletes a
Expand Down Expand Up @@ -1055,10 +1066,10 @@ def sample_delete_document():

def import_documents(
self,
request: Union[import_config.ImportDocumentsRequest, dict] = None,
request: Optional[Union[import_config.ImportDocumentsRequest, dict]] = None,
*,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
timeout: Optional[float] = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> operation.Operation:
r"""Bulk import of multiple
Expand Down Expand Up @@ -1177,10 +1188,10 @@ def __exit__(self, type, value, traceback):

def list_operations(
self,
request: operations_pb2.ListOperationsRequest = None,
request: Optional[operations_pb2.ListOperationsRequest] = None,
*,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
timeout: Optional[float] = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> operations_pb2.ListOperationsResponse:
r"""Lists operations that match the specified filter in the request.
Expand Down Expand Up @@ -1231,10 +1242,10 @@ def list_operations(

def get_operation(
self,
request: operations_pb2.GetOperationRequest = None,
request: Optional[operations_pb2.GetOperationRequest] = None,
*,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
timeout: Optional[float] = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> operations_pb2.Operation:
r"""Gets the latest state of a long-running operation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ def __init__(
self,
*,
host: str = DEFAULT_HOST,
credentials: ga_credentials.Credentials = None,
credentials: Optional[ga_credentials.Credentials] = None,
credentials_file: Optional[str] = None,
scopes: Optional[Sequence[str]] = None,
quota_project_id: Optional[str] = None,
Expand Down
Loading