chore: update generated docs (#1115)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/2ed9ab0e-55b4-4ab2-aede-c95e765f7376/targets
- [x] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/discovery-artifact-manager/commit/0bed8bdae25d545e796cfcdd7a9bfffff11e69da
Source-Link: https://github.com/googleapis/synthtool/commit/c2de32114ec484aa708d32012d1fa8d75232daf5
diff --git a/docs/dyn/bigqueryreservation_v1.projects.locations.capacityCommitments.html b/docs/dyn/bigqueryreservation_v1.projects.locations.capacityCommitments.html
index bc377fb..eced1f1 100644
--- a/docs/dyn/bigqueryreservation_v1.projects.locations.capacityCommitments.html
+++ b/docs/dyn/bigqueryreservation_v1.projects.locations.capacityCommitments.html
@@ -117,22 +117,22 @@
The object takes the form of:
{ # Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes. In order to remove annual commitment, its plan needs to be changed to monthly or flex first. A capacity commitment resource exists as a child resource of the admin project.
- "slotCount": "A String", # Number of slots in this commitment.
"renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments.
+ "plan": "A String", # Capacity commitment commitment plan.
+ "name": "A String", # Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123`
+ "commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
+ "commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
"failureStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. For FAILED commitment plan, provides the reason of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
- "commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
- "commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
- "plan": "A String", # Capacity commitment commitment plan.
- "name": "A String", # Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123`
"state": "A String", # Output only. State of the commitment.
+ "slotCount": "A String", # Number of slots in this commitment.
}
enforceSingleAdminProjectPerOrg: boolean, If true, fail the request if another project in the organization has a capacity commitment.
@@ -145,22 +145,22 @@
An object of the form:
{ # Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes. In order to remove annual commitment, its plan needs to be changed to monthly or flex first. A capacity commitment resource exists as a child resource of the admin project.
- "slotCount": "A String", # Number of slots in this commitment.
"renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments.
+ "plan": "A String", # Capacity commitment commitment plan.
+ "name": "A String", # Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123`
+ "commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
+ "commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
"failureStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. For FAILED commitment plan, provides the reason of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
- "commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
- "commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
- "plan": "A String", # Capacity commitment commitment plan.
- "name": "A String", # Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123`
"state": "A String", # Output only. State of the commitment.
+ "slotCount": "A String", # Number of slots in this commitment.
}</pre>
</div>
@@ -197,22 +197,22 @@
An object of the form:
{ # Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes. In order to remove annual commitment, its plan needs to be changed to monthly or flex first. A capacity commitment resource exists as a child resource of the admin project.
- "slotCount": "A String", # Number of slots in this commitment.
"renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments.
+ "plan": "A String", # Capacity commitment commitment plan.
+ "name": "A String", # Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123`
+ "commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
+ "commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
"failureStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. For FAILED commitment plan, provides the reason of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
- "commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
- "commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
- "plan": "A String", # Capacity commitment commitment plan.
- "name": "A String", # Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123`
"state": "A String", # Output only. State of the commitment.
+ "slotCount": "A String", # Number of slots in this commitment.
}</pre>
</div>
@@ -233,27 +233,27 @@
An object of the form:
{ # The response for ReservationService.ListCapacityCommitments.
+ "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
"capacityCommitments": [ # List of capacity commitments visible to the user.
{ # Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes. In order to remove annual commitment, its plan needs to be changed to monthly or flex first. A capacity commitment resource exists as a child resource of the admin project.
- "slotCount": "A String", # Number of slots in this commitment.
"renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments.
+ "plan": "A String", # Capacity commitment commitment plan.
+ "name": "A String", # Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123`
+ "commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
+ "commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
"failureStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. For FAILED commitment plan, provides the reason of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
- "commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
- "commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
- "plan": "A String", # Capacity commitment commitment plan.
- "name": "A String", # Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123`
"state": "A String", # Output only. State of the commitment.
+ "slotCount": "A String", # Number of slots in this commitment.
},
],
- "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
}</pre>
</div>
@@ -295,22 +295,22 @@
An object of the form:
{ # Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes. In order to remove annual commitment, its plan needs to be changed to monthly or flex first. A capacity commitment resource exists as a child resource of the admin project.
- "slotCount": "A String", # Number of slots in this commitment.
"renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments.
+ "plan": "A String", # Capacity commitment commitment plan.
+ "name": "A String", # Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123`
+ "commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
+ "commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
"failureStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. For FAILED commitment plan, provides the reason of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
- "commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
- "commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
- "plan": "A String", # Capacity commitment commitment plan.
- "name": "A String", # Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123`
"state": "A String", # Output only. State of the commitment.
+ "slotCount": "A String", # Number of slots in this commitment.
}</pre>
</div>
@@ -324,22 +324,22 @@
The object takes the form of:
{ # Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes. In order to remove annual commitment, its plan needs to be changed to monthly or flex first. A capacity commitment resource exists as a child resource of the admin project.
- "slotCount": "A String", # Number of slots in this commitment.
"renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments.
+ "plan": "A String", # Capacity commitment commitment plan.
+ "name": "A String", # Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123`
+ "commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
+ "commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
"failureStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. For FAILED commitment plan, provides the reason of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
- "commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
- "commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
- "plan": "A String", # Capacity commitment commitment plan.
- "name": "A String", # Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123`
"state": "A String", # Output only. State of the commitment.
+ "slotCount": "A String", # Number of slots in this commitment.
}
updateMask: string, Standard field mask for the set of fields to be updated.
@@ -352,22 +352,22 @@
An object of the form:
{ # Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes. In order to remove annual commitment, its plan needs to be changed to monthly or flex first. A capacity commitment resource exists as a child resource of the admin project.
- "slotCount": "A String", # Number of slots in this commitment.
"renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments.
+ "plan": "A String", # Capacity commitment commitment plan.
+ "name": "A String", # Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123`
+ "commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
+ "commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
"failureStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. For FAILED commitment plan, provides the reason of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
- "commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
- "commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
- "plan": "A String", # Capacity commitment commitment plan.
- "name": "A String", # Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123`
"state": "A String", # Output only. State of the commitment.
+ "slotCount": "A String", # Number of slots in this commitment.
}</pre>
</div>
@@ -394,40 +394,40 @@
{ # The response for ReservationService.SplitCapacityCommitment.
"second": { # Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes. In order to remove annual commitment, its plan needs to be changed to monthly or flex first. A capacity commitment resource exists as a child resource of the admin project. # Second capacity commitment, result of a split.
- "slotCount": "A String", # Number of slots in this commitment.
"renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments.
+ "plan": "A String", # Capacity commitment commitment plan.
+ "name": "A String", # Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123`
+ "commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
+ "commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
"failureStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. For FAILED commitment plan, provides the reason of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
- "commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
- "commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
- "plan": "A String", # Capacity commitment commitment plan.
- "name": "A String", # Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123`
"state": "A String", # Output only. State of the commitment.
+ "slotCount": "A String", # Number of slots in this commitment.
},
"first": { # Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes. In order to remove annual commitment, its plan needs to be changed to monthly or flex first. A capacity commitment resource exists as a child resource of the admin project. # First capacity commitment, result of a split.
- "slotCount": "A String", # Number of slots in this commitment.
"renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments.
+ "plan": "A String", # Capacity commitment commitment plan.
+ "name": "A String", # Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123`
+ "commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
+ "commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
"failureStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. For FAILED commitment plan, provides the reason of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
- "commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
- "commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
- "plan": "A String", # Capacity commitment commitment plan.
- "name": "A String", # Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123`
"state": "A String", # Output only. State of the commitment.
+ "slotCount": "A String", # Number of slots in this commitment.
},
}</pre>
</div>