Represents an AggregatedListRegionCommitmentsRequest.
Package
@google-cloud/computeConstructors
(constructor)(properties)
constructor(properties?: google.cloud.compute.v1.IAggregatedListRegionCommitmentsRequest);
Constructs a new AggregatedListRegionCommitmentsRequest.
Parameter | |
---|---|
Name | Description |
properties |
IAggregatedListRegionCommitmentsRequest
Properties to set |
Properties
_filter
public _filter?: "filter";
AggregatedListRegionCommitmentsRequest _filter.
_includeAllScopes
public _includeAllScopes?: "includeAllScopes";
AggregatedListRegionCommitmentsRequest _includeAllScopes.
_maxResults
public _maxResults?: "maxResults";
AggregatedListRegionCommitmentsRequest _maxResults.
_orderBy
public _orderBy?: "orderBy";
AggregatedListRegionCommitmentsRequest _orderBy.
_pageToken
public _pageToken?: "pageToken";
AggregatedListRegionCommitmentsRequest _pageToken.
_returnPartialSuccess
public _returnPartialSuccess?: "returnPartialSuccess";
AggregatedListRegionCommitmentsRequest _returnPartialSuccess.
_serviceProjectNumber
public _serviceProjectNumber?: "serviceProjectNumber";
AggregatedListRegionCommitmentsRequest _serviceProjectNumber.
filter
public filter?: (string|null);
AggregatedListRegionCommitmentsRequest filter.
includeAllScopes
public includeAllScopes?: (boolean|null);
AggregatedListRegionCommitmentsRequest includeAllScopes.
maxResults
public maxResults?: (number|null);
AggregatedListRegionCommitmentsRequest maxResults.
orderBy
public orderBy?: (string|null);
AggregatedListRegionCommitmentsRequest orderBy.
pageToken
public pageToken?: (string|null);
AggregatedListRegionCommitmentsRequest pageToken.
project
public project: string;
AggregatedListRegionCommitmentsRequest project.
returnPartialSuccess
public returnPartialSuccess?: (boolean|null);
AggregatedListRegionCommitmentsRequest returnPartialSuccess.
serviceProjectNumber
public serviceProjectNumber?: (number|Long|string|null);
AggregatedListRegionCommitmentsRequest serviceProjectNumber.
Methods
create(properties)
public static create(properties?: google.cloud.compute.v1.IAggregatedListRegionCommitmentsRequest): google.cloud.compute.v1.AggregatedListRegionCommitmentsRequest;
Creates a new AggregatedListRegionCommitmentsRequest instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IAggregatedListRegionCommitmentsRequest
Properties to set |
Returns | |
---|---|
Type | Description |
AggregatedListRegionCommitmentsRequest |
AggregatedListRegionCommitmentsRequest instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.compute.v1.AggregatedListRegionCommitmentsRequest;
Decodes an AggregatedListRegionCommitmentsRequest message from the specified reader or buffer.
Parameters | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Returns | |
---|---|
Type | Description |
AggregatedListRegionCommitmentsRequest |
AggregatedListRegionCommitmentsRequest |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.compute.v1.AggregatedListRegionCommitmentsRequest;
Decodes an AggregatedListRegionCommitmentsRequest message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
AggregatedListRegionCommitmentsRequest |
AggregatedListRegionCommitmentsRequest |
encode(message, writer)
public static encode(message: google.cloud.compute.v1.IAggregatedListRegionCommitmentsRequest, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified AggregatedListRegionCommitmentsRequest message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IAggregatedListRegionCommitmentsRequest
AggregatedListRegionCommitmentsRequest message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.compute.v1.IAggregatedListRegionCommitmentsRequest, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified AggregatedListRegionCommitmentsRequest message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IAggregatedListRegionCommitmentsRequest
AggregatedListRegionCommitmentsRequest message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.compute.v1.AggregatedListRegionCommitmentsRequest;
Creates an AggregatedListRegionCommitmentsRequest message from a plain object. Also converts values to their respective internal types.
Parameter | |
---|---|
Name | Description |
object |
{ [k: string]: any }
Plain object |
Returns | |
---|---|
Type | Description |
AggregatedListRegionCommitmentsRequest |
AggregatedListRegionCommitmentsRequest |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for AggregatedListRegionCommitmentsRequest
Parameter | |
---|---|
Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns | |
---|---|
Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };
Converts this AggregatedListRegionCommitmentsRequest to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.compute.v1.AggregatedListRegionCommitmentsRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from an AggregatedListRegionCommitmentsRequest message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
AggregatedListRegionCommitmentsRequest
AggregatedListRegionCommitmentsRequest |
options |
$protobuf.IConversionOptions
Conversion options |
Returns | |
---|---|
Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies an AggregatedListRegionCommitmentsRequest message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|