Infrastructure Manager v1 API - Class ListPreviewsRequest (1.5.0)

public sealed class ListPreviewsRequest : IMessage<ListPreviewsRequest>, IEquatable<ListPreviewsRequest>, IDeepCloneable<ListPreviewsRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Infrastructure Manager v1 API class ListPreviewsRequest.

A request to list all previews for a given project and location.

Inheritance

object > ListPreviewsRequest

Namespace

Google.Cloud.Config.V1

Assembly

Google.Cloud.Config.V1.dll

Constructors

ListPreviewsRequest()

public ListPreviewsRequest()

ListPreviewsRequest(ListPreviewsRequest)

public ListPreviewsRequest(ListPreviewsRequest other)
Parameter
NameDescription
otherListPreviewsRequest

Properties

Filter

public string Filter { get; set; }

Optional. Lists the Deployments that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case.

Examples:

  • Filter by name: name = "projects/foo/locations/us-central1/deployments/bar

  • Filter by labels:

    • Resources that have a key called 'foo' labels.foo:*
    • Resources that have a key called 'foo' whose value is 'bar' labels.foo = bar
  • Filter by state:

    • Deployments in CREATING state. state=CREATING
Property Value
TypeDescription
string

OrderBy

public string OrderBy { get; set; }

Optional. Field to use to sort the list.

Property Value
TypeDescription
string

PageSize

public int PageSize { get; set; }

Optional. When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000.

Property Value
TypeDescription
int

PageToken

public string PageToken { get; set; }

Optional. Token returned by previous call to 'ListDeployments' which specifies the position in the list from where to continue listing the resources.

Property Value
TypeDescription
string

Parent

public string Parent { get; set; }

Required. The parent in whose context the Previews are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

Property Value
TypeDescription
string

ParentAsLocationName

public LocationName ParentAsLocationName { get; set; }

LocationName-typed view over the Parent resource name property.

Property Value
TypeDescription
LocationName