Module pagers (1.73.0)

API documentation for aiplatform_v1.services.vizier_service.pagers module.

Classes

ListStudiesAsyncPager

ListStudiesAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.aiplatform_v1.types.vizier_service.ListStudiesResponse
        ],
    ],
    request: google.cloud.aiplatform_v1.types.vizier_service.ListStudiesRequest,
    response: google.cloud.aiplatform_v1.types.vizier_service.ListStudiesResponse,
    *,
    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]] = ()
)

A pager for iterating through list_studies requests.

This class thinly wraps an initial ListStudiesResponse object, and provides an __aiter__ method to iterate through its studies field.

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

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

ListStudiesPager

ListStudiesPager(
    method: typing.Callable[
        [...], google.cloud.aiplatform_v1.types.vizier_service.ListStudiesResponse
    ],
    request: google.cloud.aiplatform_v1.types.vizier_service.ListStudiesRequest,
    response: google.cloud.aiplatform_v1.types.vizier_service.ListStudiesResponse,
    *,
    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]] = ()
)

A pager for iterating through list_studies requests.

This class thinly wraps an initial ListStudiesResponse object, and provides an __iter__ method to iterate through its studies field.

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

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

ListTrialsAsyncPager

ListTrialsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.aiplatform_v1.types.vizier_service.ListTrialsResponse
        ],
    ],
    request: google.cloud.aiplatform_v1.types.vizier_service.ListTrialsRequest,
    response: google.cloud.aiplatform_v1.types.vizier_service.ListTrialsResponse,
    *,
    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]] = ()
)

A pager for iterating through list_trials requests.

This class thinly wraps an initial ListTrialsResponse object, and provides an __aiter__ method to iterate through its trials field.

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

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

ListTrialsPager

ListTrialsPager(
    method: typing.Callable[
        [...], google.cloud.aiplatform_v1.types.vizier_service.ListTrialsResponse
    ],
    request: google.cloud.aiplatform_v1.types.vizier_service.ListTrialsRequest,
    response: google.cloud.aiplatform_v1.types.vizier_service.ListTrialsResponse,
    *,
    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]] = ()
)

A pager for iterating through list_trials requests.

This class thinly wraps an initial ListTrialsResponse object, and provides an __iter__ method to iterate through its trials field.

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

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