All Superinterfaces:: com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:: AggregatedListSecurityPoliciesRequest, AggregatedListSecurityPoliciesRequest.Builder

@Generated public interface AggregatedListSecurityPoliciesRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type

Method

Description

String

getFilter()

A filter expression that filters resources listed in the response.

com.google.protobuf.ByteString

getFilterBytes()

A filter expression that filters resources listed in the response.

boolean

getIncludeAllScopes()

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response.

int

getMaxResults()

The maximum number of results per page that should be returned.

String

getOrderBy()

Sorts list results by a certain order.

com.google.protobuf.ByteString

getOrderByBytes()

Sorts list results by a certain order.

String

getPageToken()

Specifies a page token to use.

com.google.protobuf.ByteString

getPageTokenBytes()

Specifies a page token to use.

String

getProject()

Name of the project scoping this request.

com.google.protobuf.ByteString

getProjectBytes()

Name of the project scoping this request.

boolean

getReturnPartialSuccess()

Opt-in for partial success behavior which provides partial results in case of failure.

long

getServiceProjectNumber()

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

boolean

hasFilter()

A filter expression that filters resources listed in the response.

boolean

hasIncludeAllScopes()

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response.

boolean

hasMaxResults()

The maximum number of results per page that should be returned.

boolean

hasOrderBy()

Sorts list results by a certain order.

boolean

hasPageToken()

Specifies a page token to use.

boolean

hasReturnPartialSuccess()

Opt-in for partial success behavior which provides partial results in case of failure.

boolean

hasServiceProjectNumber()

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Details

hasFilter

boolean hasFilter()

 A filter expression that filters resources listed in the response. Most
 Compute resources support two types of filter expressions:
 expressions that support regular expressions and expressions that follow
 API improvement proposal AIP-160.
 These two types of filter expressions cannot be mixed in one request.

 If you want to use AIP-160, your expression must specify the field name, an
 operator, and the value that you want to use for filtering. The value
 must be a string, a number, or a boolean. The operator
 must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.

 For example, if you are filtering Compute Engine instances, you can
 exclude instances named `example-instance` by specifying
 `name != example-instance`.

 The `:*` comparison can be used to test whether a key has been defined.
 For example, to find all objects with `owner` label use:
 ```
 labels.owner:*
 ```

 You can also filter nested fields. For example, you could specify
 `scheduling.automaticRestart = false` to include instances only
 if they are not scheduled for automatic restarts. You can use filtering
 on nested fields to filter based onresource labels.

 To filter on multiple expressions, provide each separate expression within
 parentheses. For example:
 ```
 (scheduling.automaticRestart = true)
 (cpuPlatform = "Intel Skylake")
 ```
 By default, each expression is an `AND` expression. However, you
 can include `AND` and `OR` expressions explicitly.
 For example:
 ```
 (cpuPlatform = "Intel Skylake") OR
 (cpuPlatform = "Intel Broadwell") AND
 (scheduling.automaticRestart = true)
 ```

 If you want to use a regular expression, use the `eq` (equal) or `ne`
 (not equal) operator against a single un-parenthesized expression with or
 without quotes or against multiple parenthesized expressions. Examples:

 `fieldname eq unquoted literal`
 `fieldname eq 'single quoted literal'`
 `fieldname eq "double quoted literal"`
 `(fieldname1 eq literal) (fieldname2 ne "literal")`

 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
 The literal value must match the entire field.

 For example, to filter for instances that do not end with name "instance",
 you would use `name ne .*instance`.

 You cannot combine constraints on multiple fields using regular
 expressions.

optional string filter = 336120696;

Returns:: Whether the filter field is set.

getFilter

String getFilter()

 A filter expression that filters resources listed in the response. Most
 Compute resources support two types of filter expressions:
 expressions that support regular expressions and expressions that follow
 API improvement proposal AIP-160.
 These two types of filter expressions cannot be mixed in one request.

 If you want to use AIP-160, your expression must specify the field name, an
 operator, and the value that you want to use for filtering. The value
 must be a string, a number, or a boolean. The operator
 must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.

 For example, if you are filtering Compute Engine instances, you can
 exclude instances named `example-instance` by specifying
 `name != example-instance`.

 The `:*` comparison can be used to test whether a key has been defined.
 For example, to find all objects with `owner` label use:
 ```
 labels.owner:*
 ```

 You can also filter nested fields. For example, you could specify
 `scheduling.automaticRestart = false` to include instances only
 if they are not scheduled for automatic restarts. You can use filtering
 on nested fields to filter based onresource labels.

 To filter on multiple expressions, provide each separate expression within
 parentheses. For example:
 ```
 (scheduling.automaticRestart = true)
 (cpuPlatform = "Intel Skylake")
 ```
 By default, each expression is an `AND` expression. However, you
 can include `AND` and `OR` expressions explicitly.
 For example:
 ```
 (cpuPlatform = "Intel Skylake") OR
 (cpuPlatform = "Intel Broadwell") AND
 (scheduling.automaticRestart = true)
 ```

 If you want to use a regular expression, use the `eq` (equal) or `ne`
 (not equal) operator against a single un-parenthesized expression with or
 without quotes or against multiple parenthesized expressions. Examples:

 `fieldname eq unquoted literal`
 `fieldname eq 'single quoted literal'`
 `fieldname eq "double quoted literal"`
 `(fieldname1 eq literal) (fieldname2 ne "literal")`

 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
 The literal value must match the entire field.

 For example, to filter for instances that do not end with name "instance",
 you would use `name ne .*instance`.

 You cannot combine constraints on multiple fields using regular
 expressions.

optional string filter = 336120696;

Returns:: The filter.

getFilterBytes

com.google.protobuf.ByteString getFilterBytes()

 A filter expression that filters resources listed in the response. Most
 Compute resources support two types of filter expressions:
 expressions that support regular expressions and expressions that follow
 API improvement proposal AIP-160.
 These two types of filter expressions cannot be mixed in one request.

 If you want to use AIP-160, your expression must specify the field name, an
 operator, and the value that you want to use for filtering. The value
 must be a string, a number, or a boolean. The operator
 must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.

 For example, if you are filtering Compute Engine instances, you can
 exclude instances named `example-instance` by specifying
 `name != example-instance`.

 The `:*` comparison can be used to test whether a key has been defined.
 For example, to find all objects with `owner` label use:
 ```
 labels.owner:*
 ```

 You can also filter nested fields. For example, you could specify
 `scheduling.automaticRestart = false` to include instances only
 if they are not scheduled for automatic restarts. You can use filtering
 on nested fields to filter based onresource labels.

 To filter on multiple expressions, provide each separate expression within
 parentheses. For example:
 ```
 (scheduling.automaticRestart = true)
 (cpuPlatform = "Intel Skylake")
 ```
 By default, each expression is an `AND` expression. However, you
 can include `AND` and `OR` expressions explicitly.
 For example:
 ```
 (cpuPlatform = "Intel Skylake") OR
 (cpuPlatform = "Intel Broadwell") AND
 (scheduling.automaticRestart = true)
 ```

 If you want to use a regular expression, use the `eq` (equal) or `ne`
 (not equal) operator against a single un-parenthesized expression with or
 without quotes or against multiple parenthesized expressions. Examples:

 `fieldname eq unquoted literal`
 `fieldname eq 'single quoted literal'`
 `fieldname eq "double quoted literal"`
 `(fieldname1 eq literal) (fieldname2 ne "literal")`

 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
 The literal value must match the entire field.

 For example, to filter for instances that do not end with name "instance",
 you would use `name ne .*instance`.

 You cannot combine constraints on multiple fields using regular
 expressions.

optional string filter = 336120696;

Returns:: The bytes for filter.

hasIncludeAllScopes

boolean hasIncludeAllScopes()

 Indicates whether every visible scope for each scope type (zone, region,
 global) should be included in the response. For new resource types added
 after this field, the flag has no effect as new resource types will always
 include every visible scope for each scope type in response. For resource
 types which predate this field, if this flag is omitted or false, only
 scopes of the scope types where the resource type is expected to be found
 will be included.

optional bool include_all_scopes = 391327988;

Returns:: Whether the includeAllScopes field is set.

getIncludeAllScopes

boolean getIncludeAllScopes()

 Indicates whether every visible scope for each scope type (zone, region,
 global) should be included in the response. For new resource types added
 after this field, the flag has no effect as new resource types will always
 include every visible scope for each scope type in response. For resource
 types which predate this field, if this flag is omitted or false, only
 scopes of the scope types where the resource type is expected to be found
 will be included.

optional bool include_all_scopes = 391327988;

Returns:: The includeAllScopes.

hasMaxResults

boolean hasMaxResults()

 The maximum number of results per page that should be returned.
 If the number of available results is larger than `maxResults`,
 Compute Engine returns a `nextPageToken` that can be used to get
 the next page of results in subsequent list requests. Acceptable values are
 `0` to `500`, inclusive. (Default: `500`)

optional uint32 max_results = 54715419;

Returns:: Whether the maxResults field is set.

getMaxResults

int getMaxResults()

 The maximum number of results per page that should be returned.
 If the number of available results is larger than `maxResults`,
 Compute Engine returns a `nextPageToken` that can be used to get
 the next page of results in subsequent list requests. Acceptable values are
 `0` to `500`, inclusive. (Default: `500`)

optional uint32 max_results = 54715419;

Returns:: The maxResults.

hasOrderBy

boolean hasOrderBy()

 Sorts list results by a certain order. By default, results
 are returned in alphanumerical order based on the resource name.

 You can also sort results in descending order based on the creation
 timestamp using `orderBy="creationTimestamp desc"`. This sorts
 results based on the `creationTimestamp` field in
 reverse chronological order (newest result first). Use this to sort
 resources like operations so that the newest operation is returned first.

 Currently, only sorting by `name` or
 `creationTimestamp desc` is supported.

optional string order_by = 160562920;

Returns:: Whether the orderBy field is set.

getOrderBy

String getOrderBy()

 Sorts list results by a certain order. By default, results
 are returned in alphanumerical order based on the resource name.

 You can also sort results in descending order based on the creation
 timestamp using `orderBy="creationTimestamp desc"`. This sorts
 results based on the `creationTimestamp` field in
 reverse chronological order (newest result first). Use this to sort
 resources like operations so that the newest operation is returned first.

 Currently, only sorting by `name` or
 `creationTimestamp desc` is supported.

optional string order_by = 160562920;

Returns:: The orderBy.

getOrderByBytes

com.google.protobuf.ByteString getOrderByBytes()

 Sorts list results by a certain order. By default, results
 are returned in alphanumerical order based on the resource name.

 You can also sort results in descending order based on the creation
 timestamp using `orderBy="creationTimestamp desc"`. This sorts
 results based on the `creationTimestamp` field in
 reverse chronological order (newest result first). Use this to sort
 resources like operations so that the newest operation is returned first.

 Currently, only sorting by `name` or
 `creationTimestamp desc` is supported.

optional string order_by = 160562920;

Returns:: The bytes for orderBy.

hasPageToken

boolean hasPageToken()

 Specifies a page token to use. Set `pageToken` to the
 `nextPageToken` returned by a previous list request to get
 the next page of results.

optional string page_token = 19994697;

Returns:: Whether the pageToken field is set.

getPageToken

String getPageToken()

 Specifies a page token to use. Set `pageToken` to the
 `nextPageToken` returned by a previous list request to get
 the next page of results.

optional string page_token = 19994697;

Returns:: The pageToken.

getPageTokenBytes

com.google.protobuf.ByteString getPageTokenBytes()

 Specifies a page token to use. Set `pageToken` to the
 `nextPageToken` returned by a previous list request to get
 the next page of results.

optional string page_token = 19994697;

Returns:: The bytes for pageToken.

getProject

String getProject()
```
 Name of the project scoping this request.
 
```
string project = 227560217 [(.google.api.field_behavior) = REQUIRED];
Returns:

The project.
getProjectBytes

com.google.protobuf.ByteString getProjectBytes()
```
 Name of the project scoping this request.
 
```
string project = 227560217 [(.google.api.field_behavior) = REQUIRED];
Returns:

The bytes for project.

hasReturnPartialSuccess

boolean hasReturnPartialSuccess()

 Opt-in for partial success behavior which provides partial results in case
 of failure. The default value is false.

 For example, when partial success behavior is enabled, aggregatedList for a
 single zone scope either returns all resources in the zone or no resources,
 with an error code.

optional bool return_partial_success = 517198390;

Returns:: Whether the returnPartialSuccess field is set.

getReturnPartialSuccess

boolean getReturnPartialSuccess()

 Opt-in for partial success behavior which provides partial results in case
 of failure. The default value is false.

 For example, when partial success behavior is enabled, aggregatedList for a
 single zone scope either returns all resources in the zone or no resources,
 with an error code.

optional bool return_partial_success = 517198390;

Returns:: The returnPartialSuccess.

hasServiceProjectNumber

boolean hasServiceProjectNumber()
```
 The Shared VPC service project id or service project number for which
 aggregated list request is invoked for subnetworks list-usable api.
 
```
optional int64 service_project_number = 316757497;
Returns:

Whether the serviceProjectNumber field is set.

getServiceProjectNumber

long getServiceProjectNumber()

 The Shared VPC service project id or service project number for which
 aggregated list request is invoked for subnetworks list-usable api.

optional int64 service_project_number = 316757497;

Returns:: The serviceProjectNumber.

Interface AggregatedListSecurityPoliciesRequestOrBuilder

Method Summary

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Method Details

hasFilter

getFilter

getFilterBytes

hasIncludeAllScopes

getIncludeAllScopes

hasMaxResults

getMaxResults

hasOrderBy

getOrderBy

getOrderByBytes

hasPageToken

getPageToken

getPageTokenBytes

getProject

getProjectBytes

hasReturnPartialSuccess

getReturnPartialSuccess

hasServiceProjectNumber

getServiceProjectNumber