Class: Google::Cloud::ConfigService::V1::ListPreviewsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/config/v1/config.rb

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns 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.

Returns:

  • (::String) —

    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


1455
1456
1457
1458
 
# File 'proto_docs/google/cloud/config/v1/config.rb', line 1455

class ListPreviewsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#order_by ⇒ ::String

Returns Optional. Field to use to sort the list.

Returns:

  • (::String) —

    Optional. Field to use to sort the list.



1455
1456
1457
1458
 
# File 'proto_docs/google/cloud/config/v1/config.rb', line 1455

class ListPreviewsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

Returns 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.

Returns:

  • (::Integer) —

    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.



1455
1456
1457
1458
 
# File 'proto_docs/google/cloud/config/v1/config.rb', line 1455

class ListPreviewsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

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

Returns:

  • (::String) —

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



1455
1456
1457
1458
 
# File 'proto_docs/google/cloud/config/v1/config.rb', line 1455

class ListPreviewsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

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

Returns:

  • (::String) —

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



1455
1456
1457
1458
 
# File 'proto_docs/google/cloud/config/v1/config.rb', line 1455

class ListPreviewsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end