Class ProjectsResource.InstanceConfigOperationsResource.ListRequest
Lists the user-managed instance config long-running operations in the given project. An instance config
operation has a name of the form projects//instanceConfigs//operations/
. The long-running operation
metadata field type metadata.type_url
describes the type of the metadata. Operations returned include
those that have completed/failed/canceled within the last 7 days, and pending operations. Operations
returned are ordered by operation.metadata.value.start_time
in descending order starting from the most
recently started operation.
Inheritance
Inherited Members
Namespace: Google.Apis.Spanner.v1
Assembly: Google.Apis.Spanner.v1.dll
Syntax
public class ProjectsResource.InstanceConfigOperationsResource.ListRequest : SpannerBaseServiceRequest<ListInstanceConfigOperationsResponse>, IClientServiceRequest<ListInstanceConfigOperationsResponse>, IClientServiceRequest
Constructors
ListRequest(IClientService, string)
Constructs a new List request.
Declaration
public ListRequest(IClientService service, string parent)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
string | parent |
Properties
Filter
An expression that filters the list of returned operations. A filter expression consists of a field
name, a comparison operator, and a value for filtering. The value must be a string, a number, or a
boolean. The comparison operator must be one of: <
, >
, <=
, >=
,
!=
, =
, or :
. Colon :
is the contains operator. Filter rules are not case sensitive. The
following fields in the Operation are eligible for filtering: * name
- The name of the
long-running operation * done
- False if the operation is in progress, else true. *
metadata.@type
- the type of metadata. For example, the type string for
CreateInstanceConfigMetadata is
type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata
. * metadata.
-
any field in metadata.value. metadata.@type
must be specified first, if filtering on metadata
fields. * error
- Error associated with the long-running operation. * response.@type
- the type
of response. * response.
- any field in response.value. You can combine multiple expressions by
enclosing each expression in parentheses. By default, expressions are combined with AND logic.
However, you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * done:true
-
The operation is complete. * (metadata.@type=
type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata) AND
(metadata.instance_config.name:custom-config) AND
\ (metadata.progress.start_time < \"2021-03-28T14:50:00Z\") AND
\ (error:*)
- Return operations where: * The operation's metadata
type is CreateInstanceConfigMetadata. * The instance config name contains "custom-config". * The
operation started before 2021-03-28T14:50:00Z. * The operation resulted in an error.
Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
Type | Description |
---|---|
string |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
PageSize
Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type | Description |
---|---|
int? |
PageToken
If non-empty, page_token
should contain a next_page_token from a previous
ListInstanceConfigOperationsResponse to the same parent
and with the same filter
.
Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type | Description |
---|---|
string |
Parent
Required. The project of the instance config operations. Values are of the form projects/
.
Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type | Description |
---|---|
string |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()