Console
    Start free

    Google Cloud Ai Platform V1 Client - Class ListModelsRequest (1.56.0)

    Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ListModelsRequest.

    Request message for ModelService.ListModels .

    Generated from protobuf message google.cloud.aiplatform.v1.ListModelsRequest

    Namespace

    Google \ Cloud \ AIPlatform \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ parent
    string

    Required. The resource name of the Location to list the Models from. Format: projects/{project}/locations/{location}

    ↳ filter
    string

    An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * * model supports = and !=. model represents the Model ID, i.e. the last segment of the Model's resource name . * * display_name supports = and != * * labels supports general map functions that is: * * labels.key=value - key:value equality * * labels.key:* or labels:key - key existence * * A key including a space must be quoted. labels."a key" . * base_model_name only supports = Some examples: * model=1234 * displayName="myDisplayName" * labels.myKey="myValue" * baseModelName="text-bison"`

    ↳ page_size
    int

    The standard list page size.

    ↳ page_token
    string

    The standard list page token. Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call.

    ↳ read_mask
    Google\Protobuf\FieldMask

    Mask specifying which fields to read.

    ↳ order_by
    string

    A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * * display_name * * create_time * * update_time Example: display_name, create_time desc .

    getParent

    Required. The resource name of the Location to list the Models from.

    Format: projects/{project}/locations/{location}

    Returns
    Type
    Description
    string

    setParent

    Required. The resource name of the Location to list the Models from.

    Format: projects/{project}/locations/{location}

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getFilter

    An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.

    • model supports = and !=. model represents the Model ID, i.e. the last segment of the Model's resource name .
      • display_name supports = and !=
      • labels supports general map functions that is:
        • labels.key=value - key:value equality
        • `labels.key:* or labels:key - key existence
        • A key including a space must be quoted. labels."a key" .
      • base_model_name only supports = Some examples:
      • model=1234
      • displayName="myDisplayName"
      • labels.myKey="myValue"
      • baseModelName="text-bison"
    Returns
    Type
    Description
    string

    setFilter

    An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.

    • model supports = and !=. model represents the Model ID, i.e. the last segment of the Model's resource name .
      • display_name supports = and !=
      • labels supports general map functions that is:
        • labels.key=value - key:value equality
        • `labels.key:* or labels:key - key existence
        • A key including a space must be quoted. labels."a key" .
      • base_model_name only supports = Some examples:
      • model=1234
      • displayName="myDisplayName"
      • labels.myKey="myValue"
      • baseModelName="text-bison"
    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getPageSize

    The standard list page size.

    Returns
    Type
    Description
    int

    setPageSize

    The standard list page size.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getPageToken

    The standard list page token.

    Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call.

    Returns
    Type
    Description
    string

    setPageToken

    The standard list page token.

    Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getReadMask

    Mask specifying which fields to read.

    Returns
    Type
    Description
    Google\Protobuf\FieldMask |null

    hasReadMask

    clearReadMask

    setReadMask

    Mask specifying which fields to read.

    Parameter
    Name
    Description
    var
    Google\Protobuf\FieldMask
    Returns
    Type
    Description
    $this

    getOrderBy

    A comma-separated list of fields to order by, sorted in ascending order.

    Use "desc" after a field name for descending. Supported fields:

    • display_name
    • create_time
    • update_time Example: display_name, create_time desc .
    Returns
    Type
    Description
    string

    setOrderBy

    A comma-separated list of fields to order by, sorted in ascending order.

    Use "desc" after a field name for descending. Supported fields:

    • display_name
    • create_time
    • update_time Example: display_name, create_time desc .
    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    static::build

    Parameter
    Name
    Description
    parent
    string

    Required. The resource name of the Location to list the Models from. Format: projects/{project}/locations/{location} Please see ModelServiceClient::locationName() for help formatting this field.

    Returns
    Type
    Description
    ListModelsRequest
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: