compute  v1
Public Member Functions | Protected Member Functions | Properties | List of all members
Google.Apis.Compute.v1.BackendServicesResource.AggregatedListRequest Class Reference

Retrieves the list of all BackendService resources, regional and global, available to the specified project. More...

Inheritance diagram for Google.Apis.Compute.v1.BackendServicesResource.AggregatedListRequest:
Google.Apis.Compute.v1.ComputeBaseServiceRequest< Google.Apis.Compute.v1.Data.BackendServiceAggregatedList >

Public Member Functions

 AggregatedListRequest (Google.Apis.Services.IClientService service, string project)
 Constructs a new AggregatedList request. More...
 

Protected Member Functions

override void InitParameters ()
 Initializes AggregatedList parameter list. More...
 
- Protected Member Functions inherited from Google.Apis.Compute.v1.ComputeBaseServiceRequest< Google.Apis.Compute.v1.Data.BackendServiceAggregatedList >
 ComputeBaseServiceRequest (Google.Apis.Services.IClientService service)
 Constructs a new ComputeBaseServiceRequest instance. More...
 
override void InitParameters ()
 Initializes Compute parameter list. More...
 

Properties

virtual string Project [get]
 Name of the project scoping this request. More...
 
virtual string Filter [get, set]
 A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. More...
 
virtual System.Nullable< long > MaxResults [get, set]
 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) More...
 
virtual string OrderBy [get, set]
 Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. More...
 
virtual string PageToken [get, set]
 Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. More...
 
override string MethodName [get]
 summary>Gets the HTTP method. More...
 
override string HttpMethod [get]
 summary>Gets the REST path. More...
 
override string RestPath [get]
 
- Properties inherited from Google.Apis.Compute.v1.ComputeBaseServiceRequest< Google.Apis.Compute.v1.Data.BackendServiceAggregatedList >
virtual System.Nullable< AltEnum > Alt [get, set]
 Data format for the response. More...
 
virtual string Fields [get, set]
 Selector specifying which fields to include in a partial response. More...
 
virtual string Key [get, set]
 API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. More...
 
virtual string OauthToken [get, set]
 OAuth 2.0 token for the current user. More...
 
virtual System.Nullable< bool > PrettyPrint [get, set]
 Returns response with indentations and line breaks. More...
 
virtual string QuotaUser [get, set]
 An opaque string that represents a user for quota purposes. Must not exceed 40 characters. More...
 
virtual string UserIp [get, set]
 Deprecated. Please use quotaUser instead. More...
 

Detailed Description

Retrieves the list of all BackendService resources, regional and global, available to the specified project.

Constructor & Destructor Documentation

◆ AggregatedListRequest()

Google.Apis.Compute.v1.BackendServicesResource.AggregatedListRequest.AggregatedListRequest ( Google.Apis.Services.IClientService  service,
string  project 
)
inline

Constructs a new AggregatedList request.

Member Function Documentation

◆ InitParameters()

override void Google.Apis.Compute.v1.BackendServicesResource.AggregatedListRequest.InitParameters ( )
inlineprotected

Initializes AggregatedList parameter list.

Property Documentation

◆ Filter

virtual string Google.Apis.Compute.v1.BackendServicesResource.AggregatedListRequest.Filter
getset

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison 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.

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 on resource 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).

◆ HttpMethod

override string Google.Apis.Compute.v1.BackendServicesResource.AggregatedListRequest.HttpMethod
get

summary>Gets the REST path.

◆ MaxResults

virtual System.Nullable<long> Google.Apis.Compute.v1.BackendServicesResource.AggregatedListRequest.MaxResults
getset

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)

[default: 500] [minimum: 0]

◆ MethodName

override string Google.Apis.Compute.v1.BackendServicesResource.AggregatedListRequest.MethodName
get

summary>Gets the HTTP method.

◆ OrderBy

virtual string Google.Apis.Compute.v1.BackendServicesResource.AggregatedListRequest.OrderBy
getset

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.

◆ PageToken

virtual string Google.Apis.Compute.v1.BackendServicesResource.AggregatedListRequest.PageToken
getset

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

summary>Gets the method name.

◆ Project

virtual string Google.Apis.Compute.v1.BackendServicesResource.AggregatedListRequest.Project
get

Name of the project scoping this request.


The documentation for this class was generated from the following file: