countTokens(endpoint, body=None, x__xgafv=None)
Perform a token counting.
+
+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
predict(endpoint, body=None, x__xgafv=None)
Perform an online prediction.
@@ -149,12 +152,12 @@getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
+ Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+ "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+ { # Associates `members`, or principals, with a `role`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ },
+ ],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+predict(endpoint, body=None, x__xgafv=None)
Perform an online prediction. @@ -476,13 +514,13 @@Method Details
The object takes the form of: { # Request message for [PredictionService.GenerateContent]. - "contents": [ # Required. Input content. - { # A single turn in a conversation with the model. - "parts": [ # Required. Ordered parts that make up a message. Parts may have different MIME types. - { # Content part. + "contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. + { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. + "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. "fileData": { # URI based data. # Optional. URI based data. "fileUri": "A String", # Required. URI. - "mimeType": "A String", # Required. Mime type of the data. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. "args": { # Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. @@ -496,9 +534,9 @@Method Details
"a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Data. - "mimeType": "A String", # Required. Mime type of the data. + "inlineData": { # Raw media bytes. Text should not be sent as raw bytes, use the 'text' field. # Optional. Inlined bytes data. + "data": "A String", # Required. Raw bytes for media formats. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -507,20 +545,13 @@Method Details
}, }, ], - "role": "A String", # Optional. The role in a conversation associated with this content. Set it only if a content represents a turn in a conversations, otherwise no need to set role. Possible values: user, model. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. }, ], "endpoint": "A String", # Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Generation config. # Optional. Generation config. "candidateCount": 42, # Optional. Number of candidates to generate. - "echo": True or False, # Optional. Echo. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "logitBias": { # Optional. Logit bias. - "a_key": 3.14, - }, - "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "presencePenalty": 3.14, # Optional. Positive penalties. "stopSequences": [ # Optional. Stop sequences. "A String", ], @@ -534,13 +565,13 @@Method Details
"threshold": "A String", # Required. The harm block threshold. }, ], - "tools": [ # Optional. Tools that the model may use to generate response. - { # Tool details that the model may use to generate response. + "tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. The only supported tool is currently `Function` + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. "functionDeclarations": [ # Optional. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided. - { # Function declaration details. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - "parameters": { # Represents a select subset of an OpenAPI 3.0 Schema object. Schema is used to define the format of input/output data. More fields may be added in the future as needed. https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject # Optional. Describes the parameters to this function. Reflects the Open API 3.03 Parameter Object string Key: the name of the parameter. Parameter names are case sensitive. For function with no parameters, this can be left unset. + "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "description": "A String", # Optional. The description of the data. "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} "A String", @@ -573,7 +604,7 @@Method Details
{ # Response message for [PredictionService.GenerateContent]. "candidates": [ # Output only. Generated candidates. - { # Generated candidate. + { # A response candidate generated from the model. "citationMetadata": { # A collection of source attributions for a piece of content. # Output only. Source attribution of the generated content. "citations": [ # Output only. List of citations. { # Source attributions for content. @@ -590,12 +621,12 @@Method Details
}, ], }, - "content": { # A single turn in a conversation with the model. # Output only. Content parts of the candidate. - "parts": [ # Required. Ordered parts that make up a message. Parts may have different MIME types. - { # Content part. + "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Output only. Content parts of the candidate. + "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. "fileData": { # URI based data. # Optional. URI based data. "fileUri": "A String", # Required. URI. - "mimeType": "A String", # Required. Mime type of the data. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. "args": { # Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. @@ -609,9 +640,9 @@Method Details
"a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Data. - "mimeType": "A String", # Required. Mime type of the data. + "inlineData": { # Raw media bytes. Text should not be sent as raw bytes, use the 'text' field. # Optional. Inlined bytes data. + "data": "A String", # Required. Raw bytes for media formats. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -620,12 +651,12 @@Method Details
}, }, ], - "role": "A String", # Optional. The role in a conversation associated with this content. Set it only if a content represents a turn in a conversations, otherwise no need to set role. Possible values: user, model. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. }, - "finishMessage": "A String", # Output only. A string that describes the filtering behavior in more detail. Only filled when reason is set. - "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. + "finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. + "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. "index": 42, # Output only. Index of the candidate. - "safetyRatings": [ # Output only. Safety ratings of the generated content. + "safetyRatings": [ # Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. { # Safety rating corresponding to the generated content. "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. "category": "A String", # Output only. Harm category. diff --git a/docs/dyn/aiplatform_v1beta1.publishers.models.html b/docs/dyn/aiplatform_v1beta1.publishers.models.html index b889bdd6c29..232392ad614 100644 --- a/docs/dyn/aiplatform_v1beta1.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.publishers.models.html @@ -123,8 +123,10 @@Method Details
"parent": { # The information about the parent of a model. # Optional. The parent that this model was customized from. E.g., Vision API, Natural Language API, LaMDA, T5, etc. Foundation models don't have parents. "displayName": "A String", # Required. The display name of the parent. E.g., LaMDA, T5, Vision API, Natural Language API. "reference": { # Reference to a resource. # Optional. The Google Cloud resource name or the URI reference. + "description": "A String", # Description of the resource. "resourceName": "A String", # The resource name of the Google Cloud resource. "uri": "A String", # The URI of the resource. + "useCase": "A String", # Use case (CUJ) of the resource. }, }, "predictSchemata": { # Contains the schemata used in Model's predictions and explanations via PredictionService.Predict, PredictionService.Explain and BatchPredictionJob. # Optional. The schemata that describes formats of the PublisherModel's predictions and explanations as given and returned via PredictionService.Predict. @@ -137,8 +139,10 @@Method Details
"createApplication": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Create application using the PublisherModel. "references": { # Required. "a_key": { # Reference to a resource. + "description": "A String", # Description of the resource. "resourceName": "A String", # The resource name of the Google Cloud resource. "uri": "A String", # The URI of the resource. + "useCase": "A String", # Use case (CUJ) of the resource. }, }, "title": "A String", # Required. The title of the regional resource reference. @@ -216,14 +220,17 @@Method Details
"name": "A String", # Required. The unique name of the large Foundation or pre-built model. Like "chat-bison", "text-bison". Or model name with version ID, like "chat-bison@001", "text-bison@005", etc. }, "modelDisplayName": "A String", # Optional. Default model display name. + "publicArtifactUri": "A String", # Optional. The signed URI for ephemeral Cloud Storage access to model artifact. "sharedResources": "A String", # The resource name of the shared DeploymentResourcePool to deploy on. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` "title": "A String", # Required. The title of the regional resource reference. }, "openEvaluationPipeline": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Open evaluation pipeline of the PublisherModel. "references": { # Required. "a_key": { # Reference to a resource. + "description": "A String", # Description of the resource. "resourceName": "A String", # The resource name of the Google Cloud resource. "uri": "A String", # The URI of the resource. + "useCase": "A String", # Use case (CUJ) of the resource. }, }, "title": "A String", # Required. The title of the regional resource reference. @@ -231,8 +238,10 @@Method Details
"openFineTuningPipeline": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Open fine-tuning pipeline of the PublisherModel. "references": { # Required. "a_key": { # Reference to a resource. + "description": "A String", # Description of the resource. "resourceName": "A String", # The resource name of the Google Cloud resource. "uri": "A String", # The URI of the resource. + "useCase": "A String", # Use case (CUJ) of the resource. }, }, "title": "A String", # Required. The title of the regional resource reference. @@ -240,8 +249,10 @@Method Details
"openGenerationAiStudio": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Open in Generation AI Studio. "references": { # Required. "a_key": { # Reference to a resource. + "description": "A String", # Description of the resource. "resourceName": "A String", # The resource name of the Google Cloud resource. "uri": "A String", # The URI of the resource. + "useCase": "A String", # Use case (CUJ) of the resource. }, }, "title": "A String", # Required. The title of the regional resource reference. @@ -249,8 +260,10 @@Method Details
"openGenie": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Open Genie / Playground. "references": { # Required. "a_key": { # Reference to a resource. + "description": "A String", # Description of the resource. "resourceName": "A String", # The resource name of the Google Cloud resource. "uri": "A String", # The URI of the resource. + "useCase": "A String", # Use case (CUJ) of the resource. }, }, "title": "A String", # Required. The title of the regional resource reference. @@ -258,8 +271,10 @@Method Details
"openNotebook": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Open notebook of the PublisherModel. "references": { # Required. "a_key": { # Reference to a resource. + "description": "A String", # Description of the resource. "resourceName": "A String", # The resource name of the Google Cloud resource. "uri": "A String", # The URI of the resource. + "useCase": "A String", # Use case (CUJ) of the resource. }, }, "title": "A String", # Required. The title of the regional resource reference. @@ -267,8 +282,10 @@Method Details
"openPromptTuningPipeline": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Open prompt-tuning pipeline of the PublisherModel. "references": { # Required. "a_key": { # Reference to a resource. + "description": "A String", # Description of the resource. "resourceName": "A String", # The resource name of the Google Cloud resource. "uri": "A String", # The URI of the resource. + "useCase": "A String", # Use case (CUJ) of the resource. }, }, "title": "A String", # Required. The title of the regional resource reference. @@ -276,8 +293,10 @@Method Details
"requestAccess": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Request for access. "references": { # Required. "a_key": { # Reference to a resource. + "description": "A String", # Description of the resource. "resourceName": "A String", # The resource name of the Google Cloud resource. "uri": "A String", # The URI of the resource. + "useCase": "A String", # Use case (CUJ) of the resource. }, }, "title": "A String", # Required. The title of the regional resource reference. @@ -293,6 +312,7 @@Method Details
}, }, "versionId": "A String", # Output only. Immutable. The version ID of the PublisherModel. A new version is committed when a new model version is uploaded under an existing model id. It is an auto-incrementing decimal number in string representation. + "versionState": "A String", # Optional. Indicates the state of the model version. }
+ batchDelete(packageName, body=None, x__xgafv=None)
Deletes in-app products (managed products or subscriptions). Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput. This method should not be used to delete subscriptions. See [this article](https://android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-june-2023.html) for more information.
+
+ batchGet(packageName, sku=None, x__xgafv=None)
Reads multiple in-app products, which can be managed products or subscriptions. This method should not be used to retrieve subscriptions. See [this article](https://android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-june-2023.html) for more information.
+
+ batchUpdate(packageName, body=None, x__xgafv=None)
Updates or inserts one or more in-app products (managed products or subscriptions). Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput. This method should no longer be used to update subscriptions. See [this article](https://android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-june-2023.html) for more information.
Close httplib2 connections.
- delete(packageName, sku, x__xgafv=None)
delete(packageName, sku, latencyTolerance=None, x__xgafv=None)
Deletes an in-app product (a managed product or a subscription). This method should no longer be used to delete subscriptions. See [this article](https://android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-june-2023.html) for more information.
get(packageName, sku, x__xgafv=None)
list(packageName, maxResults=None, startIndex=None, token=None, x__xgafv=None)
Lists all in-app products - both managed products and subscriptions. If an app has a large number of in-app products, the response may be paginated. In this case the response field `tokenPagination.nextPageToken` will be set and the caller should provide its value as a `token` request parameter to retrieve the next page. This method should no longer be used to retrieve subscriptions. See [this article](https://android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-june-2023.html) for more information.
- patch(packageName, sku, autoConvertMissingPrices=None, body=None, x__xgafv=None)
patch(packageName, sku, autoConvertMissingPrices=None, body=None, latencyTolerance=None, x__xgafv=None)
Patches an in-app product (a managed product or a subscription). This method should no longer be used to update subscriptions. See [this article](https://android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-june-2023.html) for more information.
- update(packageName, sku, allowMissing=None, autoConvertMissingPrices=None, body=None, x__xgafv=None)
update(packageName, sku, allowMissing=None, autoConvertMissingPrices=None, body=None, latencyTolerance=None, x__xgafv=None)
Updates an in-app product (a managed product or a subscription). This method should no longer be used to update subscriptions. See [this article](https://android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-june-2023.html) for more information.
batchDelete(packageName, body=None, x__xgafv=None)
+ Deletes in-app products (managed products or subscriptions). Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput. This method should not be used to delete subscriptions. See [this article](https://android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-june-2023.html) for more information.
+
+Args:
+ packageName: string, Package name of the app. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request to delete multiple in-app products.
+ "requests": [ # Individual delete requests. At least one request is required. Can contain up to 100 requests. All requests must correspond to different in-app products.
+ { # Request to delete an in-app product.
+ "latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
+ "packageName": "A String", # Package name of the app.
+ "sku": "A String", # Unique identifier for the in-app product.
+ },
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+batchGet(packageName, sku=None, x__xgafv=None)
+ Reads multiple in-app products, which can be managed products or subscriptions. This method should not be used to retrieve subscriptions. See [this article](https://android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-june-2023.html) for more information.
+
+Args:
+ packageName: string, Package name of the app. (required)
+ sku: string, Unique identifier for the in-app products. (repeated)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for BatchGetSubscriptions endpoint.
+ "inappproduct": [ # The list of requested in-app products, in the same order as the request.
+ { # An in-app product. The resource for InappproductsService.
+ "defaultLanguage": "A String", # Default language of the localized data, as defined by BCP-47. e.g. "en-US".
+ "defaultPrice": { # Definition of a price, i.e. currency and units. # Default price. Cannot be zero, as in-app products are never free. Always in the developer's Checkout merchant currency.
+ "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java
+ "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string.
+ },
+ "gracePeriod": "A String", # Grace period of the subscription, specified in ISO 8601 format. Allows developers to give their subscribers a grace period when the payment for the new recurrence period is declined. Acceptable values are P0D (zero days), P3D (three days), P7D (seven days), P14D (14 days), and P30D (30 days).
+ "listings": { # List of localized title and description data. Map key is the language of the localized data, as defined by BCP-47, e.g. "en-US".
+ "a_key": { # Store listing of a single in-app product.
+ "benefits": [ # Localized entitlement benefits for a subscription.
+ "A String",
+ ],
+ "description": "A String", # Description for the store listing.
+ "title": "A String", # Title for the store listing.
+ },
+ },
+ "managedProductTaxesAndComplianceSettings": { # Details about taxation and legal compliance for managed products. # Details about taxes and legal compliance. Only applicable to managed products.
+ "eeaWithdrawalRightType": "A String", # Digital content or service classification for products distributed to users in the European Economic Area (EEA). The withdrawal regime under EEA consumer laws depends on this classification. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
+ "isTokenizedDigitalAsset": True or False, # Whether this in-app product is declared as a product representing a tokenized digital asset.
+ "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR".
+ "a_key": { # Specified details about taxation in a given geographical region.
+ "eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in United States.
+ "streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
+ "taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
+ },
+ },
+ },
+ "packageName": "A String", # Package name of the parent app.
+ "prices": { # Prices per buyer region. None of these can be zero, as in-app products are never free. Map key is region code, as defined by ISO 3166-2.
+ "a_key": { # Definition of a price, i.e. currency and units.
+ "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java
+ "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string.
+ },
+ },
+ "purchaseType": "A String", # The type of the product, e.g. a recurring subscription.
+ "sku": "A String", # Stock-keeping-unit (SKU) of the product, unique within an app.
+ "status": "A String", # The status of the product, e.g. whether it's active.
+ "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are P1W (one week), P1M (one month), P3M (three months), P6M (six months), and P1Y (one year).
+ "subscriptionTaxesAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for subscription products. # Details about taxes and legal compliance. Only applicable to subscription products.
+ "eeaWithdrawalRightType": "A String", # Digital content or service classification for products distributed to users in the European Economic Area (EEA). The withdrawal regime under EEA consumer laws depends on this classification. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
+ "isTokenizedDigitalAsset": True or False, # Whether this subscription is declared as a product representing a tokenized digital asset.
+ "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR".
+ "a_key": { # Specified details about taxation in a given geographical region.
+ "eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in United States.
+ "streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
+ "taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
+ },
+ },
+ },
+ "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between P7D (seven days) and P999D (999 days).
+ },
+ ],
+}
+batchUpdate(packageName, body=None, x__xgafv=None)
+ Updates or inserts one or more in-app products (managed products or subscriptions). Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput. This method should no longer be used to update subscriptions. See [this article](https://android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-june-2023.html) for more information.
+
+Args:
+ packageName: string, Package name of the app. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request to update or insert one or more in-app products.
+ "requests": [ # Required. Individual update requests. At least one request is required. Can contain up to 100 requests. All requests must correspond to different in-app products.
+ { # Request to update an in-app product.
+ "allowMissing": True or False, # If set to true, and the in-app product with the given package_name and sku doesn't exist, the in-app product will be created.
+ "autoConvertMissingPrices": True or False, # If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false.
+ "inappproduct": { # An in-app product. The resource for InappproductsService. # The new in-app product.
+ "defaultLanguage": "A String", # Default language of the localized data, as defined by BCP-47. e.g. "en-US".
+ "defaultPrice": { # Definition of a price, i.e. currency and units. # Default price. Cannot be zero, as in-app products are never free. Always in the developer's Checkout merchant currency.
+ "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java
+ "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string.
+ },
+ "gracePeriod": "A String", # Grace period of the subscription, specified in ISO 8601 format. Allows developers to give their subscribers a grace period when the payment for the new recurrence period is declined. Acceptable values are P0D (zero days), P3D (three days), P7D (seven days), P14D (14 days), and P30D (30 days).
+ "listings": { # List of localized title and description data. Map key is the language of the localized data, as defined by BCP-47, e.g. "en-US".
+ "a_key": { # Store listing of a single in-app product.
+ "benefits": [ # Localized entitlement benefits for a subscription.
+ "A String",
+ ],
+ "description": "A String", # Description for the store listing.
+ "title": "A String", # Title for the store listing.
+ },
+ },
+ "managedProductTaxesAndComplianceSettings": { # Details about taxation and legal compliance for managed products. # Details about taxes and legal compliance. Only applicable to managed products.
+ "eeaWithdrawalRightType": "A String", # Digital content or service classification for products distributed to users in the European Economic Area (EEA). The withdrawal regime under EEA consumer laws depends on this classification. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
+ "isTokenizedDigitalAsset": True or False, # Whether this in-app product is declared as a product representing a tokenized digital asset.
+ "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR".
+ "a_key": { # Specified details about taxation in a given geographical region.
+ "eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in United States.
+ "streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
+ "taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
+ },
+ },
+ },
+ "packageName": "A String", # Package name of the parent app.
+ "prices": { # Prices per buyer region. None of these can be zero, as in-app products are never free. Map key is region code, as defined by ISO 3166-2.
+ "a_key": { # Definition of a price, i.e. currency and units.
+ "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java
+ "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string.
+ },
+ },
+ "purchaseType": "A String", # The type of the product, e.g. a recurring subscription.
+ "sku": "A String", # Stock-keeping-unit (SKU) of the product, unique within an app.
+ "status": "A String", # The status of the product, e.g. whether it's active.
+ "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are P1W (one week), P1M (one month), P3M (three months), P6M (six months), and P1Y (one year).
+ "subscriptionTaxesAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for subscription products. # Details about taxes and legal compliance. Only applicable to subscription products.
+ "eeaWithdrawalRightType": "A String", # Digital content or service classification for products distributed to users in the European Economic Area (EEA). The withdrawal regime under EEA consumer laws depends on this classification. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
+ "isTokenizedDigitalAsset": True or False, # Whether this subscription is declared as a product representing a tokenized digital asset.
+ "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR".
+ "a_key": { # Specified details about taxation in a given geographical region.
+ "eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in United States.
+ "streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
+ "taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
+ },
+ },
+ },
+ "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between P7D (seven days) and P999D (999 days).
+ },
+ "latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
+ "packageName": "A String", # Package name of the app.
+ "sku": "A String", # Unique identifier for the in-app product.
+ },
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for a batch in-app product update.
+ "inappproducts": [ # The updated or inserted in-app products.
+ { # An in-app product. The resource for InappproductsService.
+ "defaultLanguage": "A String", # Default language of the localized data, as defined by BCP-47. e.g. "en-US".
+ "defaultPrice": { # Definition of a price, i.e. currency and units. # Default price. Cannot be zero, as in-app products are never free. Always in the developer's Checkout merchant currency.
+ "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java
+ "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string.
+ },
+ "gracePeriod": "A String", # Grace period of the subscription, specified in ISO 8601 format. Allows developers to give their subscribers a grace period when the payment for the new recurrence period is declined. Acceptable values are P0D (zero days), P3D (three days), P7D (seven days), P14D (14 days), and P30D (30 days).
+ "listings": { # List of localized title and description data. Map key is the language of the localized data, as defined by BCP-47, e.g. "en-US".
+ "a_key": { # Store listing of a single in-app product.
+ "benefits": [ # Localized entitlement benefits for a subscription.
+ "A String",
+ ],
+ "description": "A String", # Description for the store listing.
+ "title": "A String", # Title for the store listing.
+ },
+ },
+ "managedProductTaxesAndComplianceSettings": { # Details about taxation and legal compliance for managed products. # Details about taxes and legal compliance. Only applicable to managed products.
+ "eeaWithdrawalRightType": "A String", # Digital content or service classification for products distributed to users in the European Economic Area (EEA). The withdrawal regime under EEA consumer laws depends on this classification. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
+ "isTokenizedDigitalAsset": True or False, # Whether this in-app product is declared as a product representing a tokenized digital asset.
+ "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR".
+ "a_key": { # Specified details about taxation in a given geographical region.
+ "eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in United States.
+ "streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
+ "taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
+ },
+ },
+ },
+ "packageName": "A String", # Package name of the parent app.
+ "prices": { # Prices per buyer region. None of these can be zero, as in-app products are never free. Map key is region code, as defined by ISO 3166-2.
+ "a_key": { # Definition of a price, i.e. currency and units.
+ "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java
+ "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string.
+ },
+ },
+ "purchaseType": "A String", # The type of the product, e.g. a recurring subscription.
+ "sku": "A String", # Stock-keeping-unit (SKU) of the product, unique within an app.
+ "status": "A String", # The status of the product, e.g. whether it's active.
+ "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are P1W (one week), P1M (one month), P3M (three months), P6M (six months), and P1Y (one year).
+ "subscriptionTaxesAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for subscription products. # Details about taxes and legal compliance. Only applicable to subscription products.
+ "eeaWithdrawalRightType": "A String", # Digital content or service classification for products distributed to users in the European Economic Area (EEA). The withdrawal regime under EEA consumer laws depends on this classification. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
+ "isTokenizedDigitalAsset": True or False, # Whether this subscription is declared as a product representing a tokenized digital asset.
+ "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR".
+ "a_key": { # Specified details about taxation in a given geographical region.
+ "eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in United States.
+ "streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
+ "taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
+ },
+ },
+ },
+ "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between P7D (seven days) and P999D (999 days).
+ },
+ ],
+}
+close()
Close httplib2 connections.
delete(packageName, sku, x__xgafv=None)
+ delete(packageName, sku, latencyTolerance=None, x__xgafv=None)
Deletes an in-app product (a managed product or a subscription). This method should no longer be used to delete subscriptions. See [this article](https://android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-june-2023.html) for more information.
Args:
packageName: string, Package name of the app. (required)
sku: string, Unique identifier for the in-app product. (required)
+ latencyTolerance: string, Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
+ Allowed values
+ PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED - Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.
+ PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE - The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.
+ PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT - The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -391,7 +640,7 @@ Method Details
patch(packageName, sku, autoConvertMissingPrices=None, body=None, x__xgafv=None)
+ patch(packageName, sku, autoConvertMissingPrices=None, body=None, latencyTolerance=None, x__xgafv=None)
Patches an in-app product (a managed product or a subscription). This method should no longer be used to update subscriptions. See [this article](https://android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-june-2023.html) for more information. Args: @@ -453,6 +702,11 @@Method Details
} autoConvertMissingPrices: boolean, If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false. + latencyTolerance: string, Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive. + Allowed values + PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED - Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE. + PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE - The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour. + PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT - The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -515,7 +769,7 @@Method Details
update(packageName, sku, allowMissing=None, autoConvertMissingPrices=None, body=None, x__xgafv=None)
+ update(packageName, sku, allowMissing=None, autoConvertMissingPrices=None, body=None, latencyTolerance=None, x__xgafv=None)
Updates an in-app product (a managed product or a subscription). This method should no longer be used to update subscriptions. See [this article](https://android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-june-2023.html) for more information. Args: @@ -578,6 +832,11 @@Method Details
allowMissing: boolean, If set to true, and the in-app product with the given package_name and sku doesn't exist, the in-app product will be created. autoConvertMissingPrices: boolean, If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false. + latencyTolerance: string, Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive. + Allowed values + PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED - Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE. + PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE - The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour. + PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT - The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.html b/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.html index 74d648ce338..99a16a39307 100644 --- a/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.html +++ b/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.html @@ -82,6 +82,12 @@Instance Methods
activate(packageName, productId, basePlanId, body=None, x__xgafv=None)Activates a base plan. Once activated, base plans will be available to new subscribers.
++
+batchMigratePrices(packageName, productId, body=None, x__xgafv=None)Batch variant of the MigrateBasePlanPrices endpoint. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.
++
+batchUpdateStates(packageName, productId, body=None, x__xgafv=None)Activates or deactivates base plans across one or multiple subscriptions. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.
Close httplib2 connections.
@@ -107,6 +113,10 @@Method Details
The object takes the form of: { # Request message for ActivateBasePlan. + "basePlanId": "A String", # Required. The unique base plan ID of the base plan to activate. + "latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive. + "packageName": "A String", # Required. The parent app (package name) of the base plan to activate. + "productId": "A String", # Required. The parent subscription (ID) of the base plan to activate. } x__xgafv: string, V1 error format. @@ -192,6 +202,169 @@Method Details
}
batchMigratePrices(packageName, productId, body=None, x__xgafv=None)
+ Batch variant of the MigrateBasePlanPrices endpoint. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.
+
+Args:
+ packageName: string, Required. The parent app (package name) for which the subscriptions should be created or updated. Must be equal to the package_name field on all the Subscription resources. (required)
+ productId: string, Required. The product ID of the parent subscription, if all updated offers belong to the same subscription. If this batch update spans multiple subscriptions, set this field to "-". Must be set. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for BatchMigrateBasePlanPrices.
+ "requests": [ # Required. Up to 100 price migration requests. All requests must update different base plans.
+ { # Request message for MigrateBasePlanPrices.
+ "basePlanId": "A String", # Required. The unique base plan ID of the base plan to update prices on.
+ "latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
+ "packageName": "A String", # Required. Package name of the parent app. Must be equal to the package_name field on the Subscription resource.
+ "productId": "A String", # Required. The ID of the subscription to update. Must be equal to the product_id field on the Subscription resource.
+ "regionalPriceMigrations": [ # Required. The regional prices to update.
+ { # Configuration for a price migration.
+ "oldestAllowedPriceVersionTime": "A String", # Required. The cutoff time for historical prices that subscribers can remain paying. Subscribers on prices which were available at this cutoff time or later will stay on their existing price. Subscribers on older prices will be migrated to the currently-offered price. The migrated subscribers will receive a notification that they will be paying a different price. Subscribers who do not agree to the new price will have their subscription ended at the next renewal.
+ "priceIncreaseType": "A String", # Optional. The behavior the caller wants users to see when there is a price increase during migration. If left unset, the behavior defaults to PRICE_INCREASE_TYPE_OPT_IN. Note that the first opt-out price increase migration for each app must be initiated in Play Console.
+ "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
+ },
+ ],
+ "regionsVersion": { # The version of the available regions being used for the specified resource. # Required. The version of the available regions being used for the regional_price_migrations.
+ "version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02.
+ },
+ },
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for BatchMigrateBasePlanPrices.
+ "responses": [ # Contains one response per requested price migration, in the same order as the request.
+ { # Response message for MigrateBasePlanPrices.
+ },
+ ],
+}
+batchUpdateStates(packageName, productId, body=None, x__xgafv=None)
+ Activates or deactivates base plans across one or multiple subscriptions. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.
+
+Args:
+ packageName: string, Required. The parent app (package name) of the updated base plans. (required)
+ productId: string, Required. The product ID of the parent subscription, if all updated base plans belong to the same subscription. If this batch update spans multiple subscriptions, set this field to "-". Must be set. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for BatchUpdateBasePlanStates.
+ "requests": [ # Required. The update request list of up to 100 elements. All requests must update different base plans.
+ { # Request message to update the state of a subscription base plan.
+ "activateBasePlanRequest": { # Request message for ActivateBasePlan. # Activates a base plan. Once activated, base plans will be available to new subscribers.
+ "basePlanId": "A String", # Required. The unique base plan ID of the base plan to activate.
+ "latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
+ "packageName": "A String", # Required. The parent app (package name) of the base plan to activate.
+ "productId": "A String", # Required. The parent subscription (ID) of the base plan to activate.
+ },
+ "deactivateBasePlanRequest": { # Request message for DeactivateBasePlan. # Deactivates a base plan. Once deactivated, the base plan will become unavailable to new subscribers, but existing subscribers will maintain their subscription
+ "basePlanId": "A String", # Required. The unique base plan ID of the base plan to deactivate.
+ "latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
+ "packageName": "A String", # Required. The parent app (package name) of the base plan to deactivate.
+ "productId": "A String", # Required. The parent subscription (ID) of the base plan to deactivate.
+ },
+ },
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for BatchUpdateBasePlanStates.
+ "subscriptions": [ # The list of updated subscriptions. This list will match the requests one to one, in the same order.
+ { # A single subscription for an app.
+ "archived": True or False, # Output only. Whether this subscription is archived. Archived subscriptions are not available to any subscriber any longer, cannot be updated, and are not returned in list requests unless the show archived flag is passed in.
+ "basePlans": [ # The set of base plans for this subscription. Represents the prices and duration of the subscription if no other offers apply.
+ { # A single base plan for a subscription.
+ "autoRenewingBasePlanType": { # Represents a base plan that automatically renews at the end of its subscription period. # Set when the base plan automatically renews at a regular interval.
+ "billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
+ "gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration.
+ "legacyCompatible": True or False, # Whether the renewing base plan is backward compatible. The backward compatible base plan is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one renewing base plan can be marked as legacy compatible for a given subscription.
+ "legacyCompatibleSubscriptionOfferId": "A String", # Subscription offer id which is legacy compatible. The backward compatible subscription offer is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one subscription offer can be marked as legacy compatible for a given renewing base plan. To have no Subscription offer as legacy compatible set this field as empty string.
+ "prorationMode": "A String", # The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE.
+ "resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
+ },
+ "basePlanId": "A String", # Required. Immutable. The unique identifier of this base plan. Must be unique within the subscription, and conform with RFC-1034. That is, this ID can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 63 characters.
+ "offerTags": [ # List of up to 20 custom tags specified for this base plan, and returned to the app through the billing library. Subscription offers for this base plan will also receive these offer tags in the billing library.
+ { # Represents a custom tag specified for base plans and subscription offers.
+ "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
+ },
+ ],
+ "otherRegionsConfig": { # Pricing information for any new locations Play may launch in. # Pricing information for any new locations Play may launch in the future. If omitted, the BasePlan will not be automatically available any new locations Play may launch in the future.
+ "eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new locations Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "newSubscriberAvailability": True or False, # Whether the base plan is available for new subscribers in any new locations Play may launch in. If not specified, this will default to false.
+ "usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new locations Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ },
+ "prepaidBasePlanType": { # Represents a base plan that does not automatically renew at the end of the base plan, and must be manually renewed by the user. # Set when the base plan does not automatically renew at the end of the billing period.
+ "billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
+ "timeExtension": "A String", # Whether users should be able to extend this prepaid base plan in Google Play surfaces. Defaults to TIME_EXTENSION_ACTIVE if not specified.
+ },
+ "regionalConfigs": [ # Region-specific information for this base plan.
+ { # Configuration for a base plan specific to a region.
+ "newSubscriberAvailability": True or False, # Whether the base plan in the specified region is available for new subscribers. Existing subscribers will not have their subscription canceled if this value is set to false. If not specified, this will default to false.
+ "price": { # Represents an amount of money with its currency type. # The price of the base plan in the specified region. Must be set if the base plan is available to new subscribers. Must be set in the currency that is linked to the specified region.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
+ },
+ ],
+ "state": "A String", # Output only. The state of the base plan, i.e. whether it's active. Draft and inactive base plans can be activated or deleted. Active base plans can be made inactive. Inactive base plans can be canceled. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
+ },
+ ],
+ "listings": [ # Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app.
+ { # The consumer-visible metadata of a subscription.
+ "benefits": [ # A list of benefits shown to the user on platforms such as the Play Store and in restoration flows in the language of this listing. Plain text. Ordered list of at most four benefits.
+ "A String",
+ ],
+ "description": "A String", # The description of this subscription in the language of this listing. Maximum length - 80 characters. Plain text.
+ "languageCode": "A String", # Required. The language of this listing, as defined by BCP-47, e.g. "en-US".
+ "title": "A String", # Required. The title of this subscription in the language of this listing. Plain text.
+ },
+ ],
+ "packageName": "A String", # Immutable. Package name of the parent app.
+ "productId": "A String", # Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length.
+ "taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for subscription products. # Details about taxes and legal compliance.
+ "eeaWithdrawalRightType": "A String", # Digital content or service classification for products distributed to users in the European Economic Area (EEA). The withdrawal regime under EEA consumer laws depends on this classification. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
+ "isTokenizedDigitalAsset": True or False, # Whether this subscription is declared as a product representing a tokenized digital asset.
+ "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR".
+ "a_key": { # Specified details about taxation in a given geographical region.
+ "eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in United States.
+ "streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
+ "taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
+ },
+ },
+ },
+ },
+ ],
+}
+close()
Close httplib2 connections.@@ -209,6 +382,10 @@
activate(packageName, productId, basePlanId, offerId, body=None, x__xgafv=None)
Activates a subscription offer. Once activated, subscription offers will be available to new subscribers.
+
+ batchGet(packageName, productId, basePlanId, body=None, x__xgafv=None)
Reads one or more subscription offers.
+
+ batchUpdate(packageName, productId, basePlanId, body=None, x__xgafv=None)
Updates a batch of subscription offers. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.
+
+ batchUpdateStates(packageName, productId, basePlanId, body=None, x__xgafv=None)
Updates a batch of subscription offer states. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.
Close httplib2 connections.
@@ -99,7 +108,7 @@list_next()
Retrieves the next page of results.
+patch(packageName, productId, basePlanId, offerId, allowMissing=None, body=None, latencyTolerance=None, regionsVersion_version=None, updateMask=None, x__xgafv=None)
Updates an existing subscription offer.
batchGet(packageName, productId, basePlanId, body=None, x__xgafv=None)
+ Reads one or more subscription offers.
+
+Args:
+ packageName: string, Required. The parent app (package name) for which the subscriptions should be created or updated. Must be equal to the package_name field on all the requests. (required)
+ productId: string, Required. The product ID of the parent subscription, if all updated offers belong to the same subscription. If this request spans multiple subscriptions, set this field to "-". Must be set. (required)
+ basePlanId: string, Required. The parent base plan (ID) for which the offers should be read. May be specified as '-' to read offers from multiple base plans. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for BatchGetSubscriptionOffers endpoint.
+ "requests": [ # Required. A list of update requests of up to 100 elements. All requests must update different subscriptions.
+ { # Request message for GetSubscriptionOffer.
+ "basePlanId": "A String", # Required. The parent base plan (ID) of the offer to get.
+ "offerId": "A String", # Required. The unique offer ID of the offer to get.
+ "packageName": "A String", # Required. The parent app (package name) of the offer to get.
+ "productId": "A String", # Required. The parent subscription (ID) of the offer to get.
+ },
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for BatchGetSubscriptionOffers endpoint.
+ "subscriptionOffers": [
+ { # A single, temporary offer
+ "basePlanId": "A String", # Required. Immutable. The ID of the base plan to which this offer is an extension.
+ "offerId": "A String", # Required. Immutable. Unique ID of this subscription offer. Must be unique within the base plan.
+ "offerTags": [ # List of up to 20 custom tags specified for this offer, and returned to the app through the billing library.
+ { # Represents a custom tag specified for base plans and subscription offers.
+ "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
+ },
+ ],
+ "otherRegionsConfig": { # Configuration for any new locations Play may launch in specified on a subscription offer. # The configuration for any new locations Play may launch in the future.
+ "otherRegionsNewSubscriberAvailability": True or False, # Whether the subscription offer in any new locations Play may launch in the future. If not specified, this will default to false.
+ },
+ "packageName": "A String", # Required. Immutable. The package name of the app the parent subscription belongs to.
+ "phases": [ # Required. The phases of this subscription offer. Must contain at least one entry, and may contain at most five. Users will always receive all these phases in the specified order. Phases may not be added, removed, or reordered after initial creation.
+ { # A single phase of a subscription offer.
+ "duration": "A String", # Required. The duration of a single recurrence of this phase. Specified in ISO 8601 format.
+ "otherRegionsConfig": { # Configuration for any new locations Play may launch in for a single offer phase. # Pricing information for any new locations Play may launch in.
+ "absoluteDiscounts": { # Pricing information for any new locations Play may launch in. # The absolute amount of money subtracted from the base plan price prorated over the phase duration that the user pays for this offer phase. For example, if the base plan price for this region is $12 for a period of 1 year, then a $1 absolute discount for a phase of a duration of 3 months would correspond to a price of $2. The resulting price may not be smaller than the minimum price allowed for any new locations Play may launch in.
+ "eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new locations Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new locations Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ },
+ "otherRegionsPrices": { # Pricing information for any new locations Play may launch in. # The absolute price the user pays for this offer phase. The price must not be smaller than the minimum price allowed for any new locations Play may launch in.
+ "eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new locations Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new locations Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ },
+ "relativeDiscount": 3.14, # The fraction of the base plan price prorated over the phase duration that the user pays for this offer phase. For example, if the base plan price for this region is $12 for a period of 1 year, then a 50% discount for a phase of a duration of 3 months would correspond to a price of $1.50. The discount must be specified as a fraction strictly larger than 0 and strictly smaller than 1. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in any new locations Play may launch in.
+ },
+ "recurrenceCount": 42, # Required. The number of times this phase repeats. If this offer phase is not free, each recurrence charges the user the price of this offer phase.
+ "regionalConfigs": [ # Required. The region-specific configuration of this offer phase. This list must contain exactly one entry for each region for which the subscription offer has a regional config.
+ { # Configuration for a single phase of a subscription offer in a single region.
+ "absoluteDiscount": { # Represents an amount of money with its currency type. # The absolute amount of money subtracted from the base plan price prorated over the phase duration that the user pays for this offer phase. For example, if the base plan price for this region is $12 for a period of 1 year, then a $1 absolute discount for a phase of a duration of 3 months would correspond to a price of $2. The resulting price may not be smaller than the minimum price allowed for this region.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "price": { # Represents an amount of money with its currency type. # The absolute price the user pays for this offer phase. The price must not be smaller than the minimum price allowed for this region.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "regionCode": "A String", # Required. Immutable. The region to which this config applies.
+ "relativeDiscount": 3.14, # The fraction of the base plan price prorated over the phase duration that the user pays for this offer phase. For example, if the base plan price for this region is $12 for a period of 1 year, then a 50% discount for a phase of a duration of 3 months would correspond to a price of $1.50. The discount must be specified as a fraction strictly larger than 0 and strictly smaller than 1. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in this region.
+ },
+ ],
+ },
+ ],
+ "productId": "A String", # Required. Immutable. The ID of the parent subscription this offer belongs to.
+ "regionalConfigs": [ # Required. The region-specific configuration of this offer. Must contain at least one entry.
+ { # Configuration for a subscription offer in a single region.
+ "newSubscriberAvailability": True or False, # Whether the subscription offer in the specified region is available for new subscribers. Existing subscribers will not have their subscription cancelled if this value is set to false. If not specified, this will default to false.
+ "regionCode": "A String", # Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
+ },
+ ],
+ "state": "A String", # Output only. The current state of this offer. Can be changed using Activate and Deactivate actions. NB: the base plan state supersedes this state, so an active offer may not be available if the base plan is not active.
+ "targeting": { # Defines the rule a user needs to satisfy to receive this offer. # The requirements that users need to fulfil to be eligible for this offer. Represents the requirements that Play will evaluate to decide whether an offer should be returned. Developers may further filter these offers themselves.
+ "acquisitionRule": { # Represents a targeting rule of the form: User never had {scope} before. # Offer targeting rule for new user acquisition.
+ "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "any subscription in app".
+ "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app.
+ },
+ },
+ "upgradeRule": { # Represents a targeting rule of the form: User currently has {scope} [with billing period {billing_period}]. # Offer targeting rule for upgrading users' existing plans.
+ "billingPeriodDuration": "A String", # The specific billing period duration, specified in ISO 8601 format, that a user must be currently subscribed to to be eligible for this rule. If not specified, users subscribed to any billing period are matched.
+ "oncePerUser": True or False, # Limit this offer to only once per user. If set to true, a user can never be eligible for this offer again if they ever subscribed to this offer.
+ "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "specific subscription in app".
+ "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app.
+ },
+ },
+ },
+ },
+ ],
+}
+batchUpdate(packageName, productId, basePlanId, body=None, x__xgafv=None)
+ Updates a batch of subscription offers. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.
+
+Args:
+ packageName: string, Required. The parent app (package name) of the updated subscription offers. Must be equal to the package_name field on all the updated SubscriptionOffer resources. (required)
+ productId: string, Required. The product ID of the parent subscription, if all updated offers belong to the same subscription. If this request spans multiple subscriptions, set this field to "-". Must be set. (required)
+ basePlanId: string, Required. The parent base plan (ID) for which the offers should be updated. May be specified as '-' to update offers from multiple base plans. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for BatchUpdateSubscriptionOffers.
+ "requests": [ # Required. A list of update requests of up to 100 elements. All requests must update different subscription offers.
+ { # Request message for UpdateSubscriptionOffer.
+ "allowMissing": True or False, # Optional. If set to true, and the subscription offer with the given package_name, product_id, base_plan_id and offer_id doesn't exist, an offer will be created. If a new offer is created, update_mask is ignored.
+ "latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
+ "regionsVersion": { # The version of the available regions being used for the specified resource. # Required. The version of the available regions being used for the subscription_offer.
+ "version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02.
+ },
+ "subscriptionOffer": { # A single, temporary offer # Required. The subscription offer to update.
+ "basePlanId": "A String", # Required. Immutable. The ID of the base plan to which this offer is an extension.
+ "offerId": "A String", # Required. Immutable. Unique ID of this subscription offer. Must be unique within the base plan.
+ "offerTags": [ # List of up to 20 custom tags specified for this offer, and returned to the app through the billing library.
+ { # Represents a custom tag specified for base plans and subscription offers.
+ "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
+ },
+ ],
+ "otherRegionsConfig": { # Configuration for any new locations Play may launch in specified on a subscription offer. # The configuration for any new locations Play may launch in the future.
+ "otherRegionsNewSubscriberAvailability": True or False, # Whether the subscription offer in any new locations Play may launch in the future. If not specified, this will default to false.
+ },
+ "packageName": "A String", # Required. Immutable. The package name of the app the parent subscription belongs to.
+ "phases": [ # Required. The phases of this subscription offer. Must contain at least one entry, and may contain at most five. Users will always receive all these phases in the specified order. Phases may not be added, removed, or reordered after initial creation.
+ { # A single phase of a subscription offer.
+ "duration": "A String", # Required. The duration of a single recurrence of this phase. Specified in ISO 8601 format.
+ "otherRegionsConfig": { # Configuration for any new locations Play may launch in for a single offer phase. # Pricing information for any new locations Play may launch in.
+ "absoluteDiscounts": { # Pricing information for any new locations Play may launch in. # The absolute amount of money subtracted from the base plan price prorated over the phase duration that the user pays for this offer phase. For example, if the base plan price for this region is $12 for a period of 1 year, then a $1 absolute discount for a phase of a duration of 3 months would correspond to a price of $2. The resulting price may not be smaller than the minimum price allowed for any new locations Play may launch in.
+ "eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new locations Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new locations Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ },
+ "otherRegionsPrices": { # Pricing information for any new locations Play may launch in. # The absolute price the user pays for this offer phase. The price must not be smaller than the minimum price allowed for any new locations Play may launch in.
+ "eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new locations Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new locations Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ },
+ "relativeDiscount": 3.14, # The fraction of the base plan price prorated over the phase duration that the user pays for this offer phase. For example, if the base plan price for this region is $12 for a period of 1 year, then a 50% discount for a phase of a duration of 3 months would correspond to a price of $1.50. The discount must be specified as a fraction strictly larger than 0 and strictly smaller than 1. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in any new locations Play may launch in.
+ },
+ "recurrenceCount": 42, # Required. The number of times this phase repeats. If this offer phase is not free, each recurrence charges the user the price of this offer phase.
+ "regionalConfigs": [ # Required. The region-specific configuration of this offer phase. This list must contain exactly one entry for each region for which the subscription offer has a regional config.
+ { # Configuration for a single phase of a subscription offer in a single region.
+ "absoluteDiscount": { # Represents an amount of money with its currency type. # The absolute amount of money subtracted from the base plan price prorated over the phase duration that the user pays for this offer phase. For example, if the base plan price for this region is $12 for a period of 1 year, then a $1 absolute discount for a phase of a duration of 3 months would correspond to a price of $2. The resulting price may not be smaller than the minimum price allowed for this region.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "price": { # Represents an amount of money with its currency type. # The absolute price the user pays for this offer phase. The price must not be smaller than the minimum price allowed for this region.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "regionCode": "A String", # Required. Immutable. The region to which this config applies.
+ "relativeDiscount": 3.14, # The fraction of the base plan price prorated over the phase duration that the user pays for this offer phase. For example, if the base plan price for this region is $12 for a period of 1 year, then a 50% discount for a phase of a duration of 3 months would correspond to a price of $1.50. The discount must be specified as a fraction strictly larger than 0 and strictly smaller than 1. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in this region.
+ },
+ ],
+ },
+ ],
+ "productId": "A String", # Required. Immutable. The ID of the parent subscription this offer belongs to.
+ "regionalConfigs": [ # Required. The region-specific configuration of this offer. Must contain at least one entry.
+ { # Configuration for a subscription offer in a single region.
+ "newSubscriberAvailability": True or False, # Whether the subscription offer in the specified region is available for new subscribers. Existing subscribers will not have their subscription cancelled if this value is set to false. If not specified, this will default to false.
+ "regionCode": "A String", # Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
+ },
+ ],
+ "state": "A String", # Output only. The current state of this offer. Can be changed using Activate and Deactivate actions. NB: the base plan state supersedes this state, so an active offer may not be available if the base plan is not active.
+ "targeting": { # Defines the rule a user needs to satisfy to receive this offer. # The requirements that users need to fulfil to be eligible for this offer. Represents the requirements that Play will evaluate to decide whether an offer should be returned. Developers may further filter these offers themselves.
+ "acquisitionRule": { # Represents a targeting rule of the form: User never had {scope} before. # Offer targeting rule for new user acquisition.
+ "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "any subscription in app".
+ "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app.
+ },
+ },
+ "upgradeRule": { # Represents a targeting rule of the form: User currently has {scope} [with billing period {billing_period}]. # Offer targeting rule for upgrading users' existing plans.
+ "billingPeriodDuration": "A String", # The specific billing period duration, specified in ISO 8601 format, that a user must be currently subscribed to to be eligible for this rule. If not specified, users subscribed to any billing period are matched.
+ "oncePerUser": True or False, # Limit this offer to only once per user. If set to true, a user can never be eligible for this offer again if they ever subscribed to this offer.
+ "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "specific subscription in app".
+ "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app.
+ },
+ },
+ },
+ },
+ "updateMask": "A String", # Required. The list of fields to be updated.
+ },
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for BatchUpdateSubscriptionOffers.
+ "subscriptionOffers": [ # The updated subscription offers list.
+ { # A single, temporary offer
+ "basePlanId": "A String", # Required. Immutable. The ID of the base plan to which this offer is an extension.
+ "offerId": "A String", # Required. Immutable. Unique ID of this subscription offer. Must be unique within the base plan.
+ "offerTags": [ # List of up to 20 custom tags specified for this offer, and returned to the app through the billing library.
+ { # Represents a custom tag specified for base plans and subscription offers.
+ "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
+ },
+ ],
+ "otherRegionsConfig": { # Configuration for any new locations Play may launch in specified on a subscription offer. # The configuration for any new locations Play may launch in the future.
+ "otherRegionsNewSubscriberAvailability": True or False, # Whether the subscription offer in any new locations Play may launch in the future. If not specified, this will default to false.
+ },
+ "packageName": "A String", # Required. Immutable. The package name of the app the parent subscription belongs to.
+ "phases": [ # Required. The phases of this subscription offer. Must contain at least one entry, and may contain at most five. Users will always receive all these phases in the specified order. Phases may not be added, removed, or reordered after initial creation.
+ { # A single phase of a subscription offer.
+ "duration": "A String", # Required. The duration of a single recurrence of this phase. Specified in ISO 8601 format.
+ "otherRegionsConfig": { # Configuration for any new locations Play may launch in for a single offer phase. # Pricing information for any new locations Play may launch in.
+ "absoluteDiscounts": { # Pricing information for any new locations Play may launch in. # The absolute amount of money subtracted from the base plan price prorated over the phase duration that the user pays for this offer phase. For example, if the base plan price for this region is $12 for a period of 1 year, then a $1 absolute discount for a phase of a duration of 3 months would correspond to a price of $2. The resulting price may not be smaller than the minimum price allowed for any new locations Play may launch in.
+ "eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new locations Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new locations Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ },
+ "otherRegionsPrices": { # Pricing information for any new locations Play may launch in. # The absolute price the user pays for this offer phase. The price must not be smaller than the minimum price allowed for any new locations Play may launch in.
+ "eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new locations Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new locations Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ },
+ "relativeDiscount": 3.14, # The fraction of the base plan price prorated over the phase duration that the user pays for this offer phase. For example, if the base plan price for this region is $12 for a period of 1 year, then a 50% discount for a phase of a duration of 3 months would correspond to a price of $1.50. The discount must be specified as a fraction strictly larger than 0 and strictly smaller than 1. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in any new locations Play may launch in.
+ },
+ "recurrenceCount": 42, # Required. The number of times this phase repeats. If this offer phase is not free, each recurrence charges the user the price of this offer phase.
+ "regionalConfigs": [ # Required. The region-specific configuration of this offer phase. This list must contain exactly one entry for each region for which the subscription offer has a regional config.
+ { # Configuration for a single phase of a subscription offer in a single region.
+ "absoluteDiscount": { # Represents an amount of money with its currency type. # The absolute amount of money subtracted from the base plan price prorated over the phase duration that the user pays for this offer phase. For example, if the base plan price for this region is $12 for a period of 1 year, then a $1 absolute discount for a phase of a duration of 3 months would correspond to a price of $2. The resulting price may not be smaller than the minimum price allowed for this region.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "price": { # Represents an amount of money with its currency type. # The absolute price the user pays for this offer phase. The price must not be smaller than the minimum price allowed for this region.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "regionCode": "A String", # Required. Immutable. The region to which this config applies.
+ "relativeDiscount": 3.14, # The fraction of the base plan price prorated over the phase duration that the user pays for this offer phase. For example, if the base plan price for this region is $12 for a period of 1 year, then a 50% discount for a phase of a duration of 3 months would correspond to a price of $1.50. The discount must be specified as a fraction strictly larger than 0 and strictly smaller than 1. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in this region.
+ },
+ ],
+ },
+ ],
+ "productId": "A String", # Required. Immutable. The ID of the parent subscription this offer belongs to.
+ "regionalConfigs": [ # Required. The region-specific configuration of this offer. Must contain at least one entry.
+ { # Configuration for a subscription offer in a single region.
+ "newSubscriberAvailability": True or False, # Whether the subscription offer in the specified region is available for new subscribers. Existing subscribers will not have their subscription cancelled if this value is set to false. If not specified, this will default to false.
+ "regionCode": "A String", # Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
+ },
+ ],
+ "state": "A String", # Output only. The current state of this offer. Can be changed using Activate and Deactivate actions. NB: the base plan state supersedes this state, so an active offer may not be available if the base plan is not active.
+ "targeting": { # Defines the rule a user needs to satisfy to receive this offer. # The requirements that users need to fulfil to be eligible for this offer. Represents the requirements that Play will evaluate to decide whether an offer should be returned. Developers may further filter these offers themselves.
+ "acquisitionRule": { # Represents a targeting rule of the form: User never had {scope} before. # Offer targeting rule for new user acquisition.
+ "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "any subscription in app".
+ "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app.
+ },
+ },
+ "upgradeRule": { # Represents a targeting rule of the form: User currently has {scope} [with billing period {billing_period}]. # Offer targeting rule for upgrading users' existing plans.
+ "billingPeriodDuration": "A String", # The specific billing period duration, specified in ISO 8601 format, that a user must be currently subscribed to to be eligible for this rule. If not specified, users subscribed to any billing period are matched.
+ "oncePerUser": True or False, # Limit this offer to only once per user. If set to true, a user can never be eligible for this offer again if they ever subscribed to this offer.
+ "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "specific subscription in app".
+ "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app.
+ },
+ },
+ },
+ },
+ ],
+}
+batchUpdateStates(packageName, productId, basePlanId, body=None, x__xgafv=None)
+ Updates a batch of subscription offer states. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.
+
+Args:
+ packageName: string, Required. The parent app (package name) of the updated subscription offers. Must be equal to the package_name field on all the updated SubscriptionOffer resources. (required)
+ productId: string, Required. The product ID of the parent subscription, if all updated offers belong to the same subscription. If this request spans multiple subscriptions, set this field to "-". Must be set. (required)
+ basePlanId: string, Required. The parent base plan (ID) for which the offers should be updated. May be specified as '-' to update offers from multiple base plans. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for BatchUpdateSubscriptionOfferStates.
+ "requests": [ # Required. The update request list of up to 100 elements. All requests must update different offers.
+ { # Request message to update the state of a subscription offer.
+ "activateSubscriptionOfferRequest": { # Request message for ActivateSubscriptionOffer. # Activates an offer. Once activated, the offer will be available to new subscribers.
+ "basePlanId": "A String", # Required. The parent base plan (ID) of the offer to activate.
+ "latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
+ "offerId": "A String", # Required. The unique offer ID of the offer to activate.
+ "packageName": "A String", # Required. The parent app (package name) of the offer to activate.
+ "productId": "A String", # Required. The parent subscription (ID) of the offer to activate.
+ },
+ "deactivateSubscriptionOfferRequest": { # Request message for DeactivateSubscriptionOffer. # Deactivates an offer. Once deactivated, the offer will become unavailable to new subscribers, but existing subscribers will maintain their subscription
+ "basePlanId": "A String", # Required. The parent base plan (ID) of the offer to deactivate.
+ "latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
+ "offerId": "A String", # Required. The unique offer ID of the offer to deactivate.
+ "packageName": "A String", # Required. The parent app (package name) of the offer to deactivate.
+ "productId": "A String", # Required. The parent subscription (ID) of the offer to deactivate.
+ },
+ },
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for BatchUpdateSubscriptionOfferStates.
+ "subscriptionOffers": [ # The updated subscription offers list.
+ { # A single, temporary offer
+ "basePlanId": "A String", # Required. Immutable. The ID of the base plan to which this offer is an extension.
+ "offerId": "A String", # Required. Immutable. Unique ID of this subscription offer. Must be unique within the base plan.
+ "offerTags": [ # List of up to 20 custom tags specified for this offer, and returned to the app through the billing library.
+ { # Represents a custom tag specified for base plans and subscription offers.
+ "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
+ },
+ ],
+ "otherRegionsConfig": { # Configuration for any new locations Play may launch in specified on a subscription offer. # The configuration for any new locations Play may launch in the future.
+ "otherRegionsNewSubscriberAvailability": True or False, # Whether the subscription offer in any new locations Play may launch in the future. If not specified, this will default to false.
+ },
+ "packageName": "A String", # Required. Immutable. The package name of the app the parent subscription belongs to.
+ "phases": [ # Required. The phases of this subscription offer. Must contain at least one entry, and may contain at most five. Users will always receive all these phases in the specified order. Phases may not be added, removed, or reordered after initial creation.
+ { # A single phase of a subscription offer.
+ "duration": "A String", # Required. The duration of a single recurrence of this phase. Specified in ISO 8601 format.
+ "otherRegionsConfig": { # Configuration for any new locations Play may launch in for a single offer phase. # Pricing information for any new locations Play may launch in.
+ "absoluteDiscounts": { # Pricing information for any new locations Play may launch in. # The absolute amount of money subtracted from the base plan price prorated over the phase duration that the user pays for this offer phase. For example, if the base plan price for this region is $12 for a period of 1 year, then a $1 absolute discount for a phase of a duration of 3 months would correspond to a price of $2. The resulting price may not be smaller than the minimum price allowed for any new locations Play may launch in.
+ "eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new locations Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new locations Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ },
+ "otherRegionsPrices": { # Pricing information for any new locations Play may launch in. # The absolute price the user pays for this offer phase. The price must not be smaller than the minimum price allowed for any new locations Play may launch in.
+ "eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new locations Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new locations Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ },
+ "relativeDiscount": 3.14, # The fraction of the base plan price prorated over the phase duration that the user pays for this offer phase. For example, if the base plan price for this region is $12 for a period of 1 year, then a 50% discount for a phase of a duration of 3 months would correspond to a price of $1.50. The discount must be specified as a fraction strictly larger than 0 and strictly smaller than 1. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in any new locations Play may launch in.
+ },
+ "recurrenceCount": 42, # Required. The number of times this phase repeats. If this offer phase is not free, each recurrence charges the user the price of this offer phase.
+ "regionalConfigs": [ # Required. The region-specific configuration of this offer phase. This list must contain exactly one entry for each region for which the subscription offer has a regional config.
+ { # Configuration for a single phase of a subscription offer in a single region.
+ "absoluteDiscount": { # Represents an amount of money with its currency type. # The absolute amount of money subtracted from the base plan price prorated over the phase duration that the user pays for this offer phase. For example, if the base plan price for this region is $12 for a period of 1 year, then a $1 absolute discount for a phase of a duration of 3 months would correspond to a price of $2. The resulting price may not be smaller than the minimum price allowed for this region.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "price": { # Represents an amount of money with its currency type. # The absolute price the user pays for this offer phase. The price must not be smaller than the minimum price allowed for this region.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "regionCode": "A String", # Required. Immutable. The region to which this config applies.
+ "relativeDiscount": 3.14, # The fraction of the base plan price prorated over the phase duration that the user pays for this offer phase. For example, if the base plan price for this region is $12 for a period of 1 year, then a 50% discount for a phase of a duration of 3 months would correspond to a price of $1.50. The discount must be specified as a fraction strictly larger than 0 and strictly smaller than 1. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in this region.
+ },
+ ],
+ },
+ ],
+ "productId": "A String", # Required. Immutable. The ID of the parent subscription this offer belongs to.
+ "regionalConfigs": [ # Required. The region-specific configuration of this offer. Must contain at least one entry.
+ { # Configuration for a subscription offer in a single region.
+ "newSubscriberAvailability": True or False, # Whether the subscription offer in the specified region is available for new subscribers. Existing subscribers will not have their subscription cancelled if this value is set to false. If not specified, this will default to false.
+ "regionCode": "A String", # Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
+ },
+ ],
+ "state": "A String", # Output only. The current state of this offer. Can be changed using Activate and Deactivate actions. NB: the base plan state supersedes this state, so an active offer may not be available if the base plan is not active.
+ "targeting": { # Defines the rule a user needs to satisfy to receive this offer. # The requirements that users need to fulfil to be eligible for this offer. Represents the requirements that Play will evaluate to decide whether an offer should be returned. Developers may further filter these offers themselves.
+ "acquisitionRule": { # Represents a targeting rule of the form: User never had {scope} before. # Offer targeting rule for new user acquisition.
+ "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "any subscription in app".
+ "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app.
+ },
+ },
+ "upgradeRule": { # Represents a targeting rule of the form: User currently has {scope} [with billing period {billing_period}]. # Offer targeting rule for upgrading users' existing plans.
+ "billingPeriodDuration": "A String", # The specific billing period duration, specified in ISO 8601 format, that a user must be currently subscribed to to be eligible for this rule. If not specified, users subscribed to any billing period are matched.
+ "oncePerUser": True or False, # Limit this offer to only once per user. If set to true, a user can never be eligible for this offer again if they ever subscribed to this offer.
+ "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "specific subscription in app".
+ "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app.
+ },
+ },
+ },
+ },
+ ],
+}
+close()
Close httplib2 connections.@@ -421,6 +891,11 @@
patch(packageName, productId, basePlanId, offerId, body=None, regionsVersion_version=None, updateMask=None, x__xgafv=None)
+ patch(packageName, productId, basePlanId, offerId, allowMissing=None, body=None, latencyTolerance=None, regionsVersion_version=None, updateMask=None, x__xgafv=None)
Updates an existing subscription offer. Args: @@ -856,6 +1331,12 @@Method Details
}, } + allowMissing: boolean, Optional. If set to true, and the subscription offer with the given package_name, product_id, base_plan_id and offer_id doesn't exist, an offer will be created. If a new offer is created, update_mask is ignored. + latencyTolerance: string, Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive. + Allowed values + PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED - Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE. + PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE - The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour. + PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT - The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods. regionsVersion_version: string, Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02. updateMask: string, Required. The list of fields to be updated. x__xgafv: string, V1 error format. diff --git a/docs/dyn/androidpublisher_v3.monetization.subscriptions.html b/docs/dyn/androidpublisher_v3.monetization.subscriptions.html index c4cbff8df36..481903e74b9 100644 --- a/docs/dyn/androidpublisher_v3.monetization.subscriptions.html +++ b/docs/dyn/androidpublisher_v3.monetization.subscriptions.html @@ -82,6 +82,12 @@Instance Methods
archive(packageName, productId, body=None, x__xgafv=None)Archives a subscription. Can only be done if at least one base plan was active in the past, and no base plan is available for new or existing subscribers currently. This action is irreversible, and the subscription ID will remain reserved.
++
+batchGet(packageName, productIds=None, x__xgafv=None)Reads one or more subscriptions.
++
+batchUpdate(packageName, body=None, x__xgafv=None)Updates a batch of subscriptions. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.
Close httplib2 connections.
@@ -101,7 +107,7 @@Instance Methods
list_next()Retrieves the next page of results.
+patch(packageName, productId, allowMissing=None, body=None, latencyTolerance=None, regionsVersion_version=None, updateMask=None, x__xgafv=None)Updates an existing subscription.
Method Details
@@ -200,6 +206,282 @@+Method Details
}++ +batchGet(packageName, productIds=None, x__xgafv=None)+Reads one or more subscriptions. + +Args: + packageName: string, Required. The parent app (package name) for which the subscriptions should be retrieved. Must be equal to the package_name field on all the requests. (required) + productIds: string, Required. A list of up to 100 subscription product IDs to retrieve. All the IDs must be different. (repeated) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response message for BatchGetSubscriptions endpoint. + "subscriptions": [ # The list of requested subscriptions, in the same order as the request. + { # A single subscription for an app. + "archived": True or False, # Output only. Whether this subscription is archived. Archived subscriptions are not available to any subscriber any longer, cannot be updated, and are not returned in list requests unless the show archived flag is passed in. + "basePlans": [ # The set of base plans for this subscription. Represents the prices and duration of the subscription if no other offers apply. + { # A single base plan for a subscription. + "autoRenewingBasePlanType": { # Represents a base plan that automatically renews at the end of its subscription period. # Set when the base plan automatically renews at a regular interval. + "billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. + "gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration. + "legacyCompatible": True or False, # Whether the renewing base plan is backward compatible. The backward compatible base plan is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one renewing base plan can be marked as legacy compatible for a given subscription. + "legacyCompatibleSubscriptionOfferId": "A String", # Subscription offer id which is legacy compatible. The backward compatible subscription offer is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one subscription offer can be marked as legacy compatible for a given renewing base plan. To have no Subscription offer as legacy compatible set this field as empty string. + "prorationMode": "A String", # The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE. + "resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified. + }, + "basePlanId": "A String", # Required. Immutable. The unique identifier of this base plan. Must be unique within the subscription, and conform with RFC-1034. That is, this ID can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 63 characters. + "offerTags": [ # List of up to 20 custom tags specified for this base plan, and returned to the app through the billing library. Subscription offers for this base plan will also receive these offer tags in the billing library. + { # Represents a custom tag specified for base plans and subscription offers. + "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters. + }, + ], + "otherRegionsConfig": { # Pricing information for any new locations Play may launch in. # Pricing information for any new locations Play may launch in the future. If omitted, the BasePlan will not be automatically available any new locations Play may launch in the future. + "eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new locations Play may launch in. + "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. + "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + }, + "newSubscriberAvailability": True or False, # Whether the base plan is available for new subscribers in any new locations Play may launch in. If not specified, this will default to false. + "usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new locations Play may launch in. + "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. + "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + }, + }, + "prepaidBasePlanType": { # Represents a base plan that does not automatically renew at the end of the base plan, and must be manually renewed by the user. # Set when the base plan does not automatically renew at the end of the billing period. + "billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. + "timeExtension": "A String", # Whether users should be able to extend this prepaid base plan in Google Play surfaces. Defaults to TIME_EXTENSION_ACTIVE if not specified. + }, + "regionalConfigs": [ # Region-specific information for this base plan. + { # Configuration for a base plan specific to a region. + "newSubscriberAvailability": True or False, # Whether the base plan in the specified region is available for new subscribers. Existing subscribers will not have their subscription canceled if this value is set to false. If not specified, this will default to false. + "price": { # Represents an amount of money with its currency type. # The price of the base plan in the specified region. Must be set if the base plan is available to new subscribers. Must be set in the currency that is linked to the specified region. + "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. + "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + }, + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + }, + ], + "state": "A String", # Output only. The state of the base plan, i.e. whether it's active. Draft and inactive base plans can be activated or deleted. Active base plans can be made inactive. Inactive base plans can be canceled. This field cannot be changed by updating the resource. Use the dedicated endpoints instead. + }, + ], + "listings": [ # Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app. + { # The consumer-visible metadata of a subscription. + "benefits": [ # A list of benefits shown to the user on platforms such as the Play Store and in restoration flows in the language of this listing. Plain text. Ordered list of at most four benefits. + "A String", + ], + "description": "A String", # The description of this subscription in the language of this listing. Maximum length - 80 characters. Plain text. + "languageCode": "A String", # Required. The language of this listing, as defined by BCP-47, e.g. "en-US". + "title": "A String", # Required. The title of this subscription in the language of this listing. Plain text. + }, + ], + "packageName": "A String", # Immutable. Package name of the parent app. + "productId": "A String", # Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length. + "taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for subscription products. # Details about taxes and legal compliance. + "eeaWithdrawalRightType": "A String", # Digital content or service classification for products distributed to users in the European Economic Area (EEA). The withdrawal regime under EEA consumer laws depends on this classification. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information. + "isTokenizedDigitalAsset": True or False, # Whether this subscription is declared as a product representing a tokenized digital asset. + "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". + "a_key": { # Specified details about taxation in a given geographical region. + "eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in United States. + "streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax). + "taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498). + }, + }, + }, + }, + ], +}+++batchUpdate(packageName, body=None, x__xgafv=None)+Updates a batch of subscriptions. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput. + +Args: + packageName: string, Required. The parent app (package name) for which the subscriptions should be updated. Must be equal to the package_name field on all the Subscription resources. (required) + body: object, The request body. + The object takes the form of: + +{ # Request message for BatchUpdateSubscription. + "requests": [ # Required. A list of update requests of up to 100 elements. All requests must update different subscriptions. + { # Request message for UpdateSubscription. + "allowMissing": True or False, # Optional. If set to true, and the subscription with the given package_name and product_id doesn't exist, the subscription will be created. If a new subscription is created, update_mask is ignored. + "latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive. + "regionsVersion": { # The version of the available regions being used for the specified resource. # Required. The version of the available regions being used for the subscription. + "version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02. + }, + "subscription": { # A single subscription for an app. # Required. The subscription to update. + "archived": True or False, # Output only. Whether this subscription is archived. Archived subscriptions are not available to any subscriber any longer, cannot be updated, and are not returned in list requests unless the show archived flag is passed in. + "basePlans": [ # The set of base plans for this subscription. Represents the prices and duration of the subscription if no other offers apply. + { # A single base plan for a subscription. + "autoRenewingBasePlanType": { # Represents a base plan that automatically renews at the end of its subscription period. # Set when the base plan automatically renews at a regular interval. + "billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. + "gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration. + "legacyCompatible": True or False, # Whether the renewing base plan is backward compatible. The backward compatible base plan is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one renewing base plan can be marked as legacy compatible for a given subscription. + "legacyCompatibleSubscriptionOfferId": "A String", # Subscription offer id which is legacy compatible. The backward compatible subscription offer is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one subscription offer can be marked as legacy compatible for a given renewing base plan. To have no Subscription offer as legacy compatible set this field as empty string. + "prorationMode": "A String", # The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE. + "resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified. + }, + "basePlanId": "A String", # Required. Immutable. The unique identifier of this base plan. Must be unique within the subscription, and conform with RFC-1034. That is, this ID can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 63 characters. + "offerTags": [ # List of up to 20 custom tags specified for this base plan, and returned to the app through the billing library. Subscription offers for this base plan will also receive these offer tags in the billing library. + { # Represents a custom tag specified for base plans and subscription offers. + "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters. + }, + ], + "otherRegionsConfig": { # Pricing information for any new locations Play may launch in. # Pricing information for any new locations Play may launch in the future. If omitted, the BasePlan will not be automatically available any new locations Play may launch in the future. + "eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new locations Play may launch in. + "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. + "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + }, + "newSubscriberAvailability": True or False, # Whether the base plan is available for new subscribers in any new locations Play may launch in. If not specified, this will default to false. + "usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new locations Play may launch in. + "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. + "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + }, + }, + "prepaidBasePlanType": { # Represents a base plan that does not automatically renew at the end of the base plan, and must be manually renewed by the user. # Set when the base plan does not automatically renew at the end of the billing period. + "billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. + "timeExtension": "A String", # Whether users should be able to extend this prepaid base plan in Google Play surfaces. Defaults to TIME_EXTENSION_ACTIVE if not specified. + }, + "regionalConfigs": [ # Region-specific information for this base plan. + { # Configuration for a base plan specific to a region. + "newSubscriberAvailability": True or False, # Whether the base plan in the specified region is available for new subscribers. Existing subscribers will not have their subscription canceled if this value is set to false. If not specified, this will default to false. + "price": { # Represents an amount of money with its currency type. # The price of the base plan in the specified region. Must be set if the base plan is available to new subscribers. Must be set in the currency that is linked to the specified region. + "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. + "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + }, + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + }, + ], + "state": "A String", # Output only. The state of the base plan, i.e. whether it's active. Draft and inactive base plans can be activated or deleted. Active base plans can be made inactive. Inactive base plans can be canceled. This field cannot be changed by updating the resource. Use the dedicated endpoints instead. + }, + ], + "listings": [ # Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app. + { # The consumer-visible metadata of a subscription. + "benefits": [ # A list of benefits shown to the user on platforms such as the Play Store and in restoration flows in the language of this listing. Plain text. Ordered list of at most four benefits. + "A String", + ], + "description": "A String", # The description of this subscription in the language of this listing. Maximum length - 80 characters. Plain text. + "languageCode": "A String", # Required. The language of this listing, as defined by BCP-47, e.g. "en-US". + "title": "A String", # Required. The title of this subscription in the language of this listing. Plain text. + }, + ], + "packageName": "A String", # Immutable. Package name of the parent app. + "productId": "A String", # Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length. + "taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for subscription products. # Details about taxes and legal compliance. + "eeaWithdrawalRightType": "A String", # Digital content or service classification for products distributed to users in the European Economic Area (EEA). The withdrawal regime under EEA consumer laws depends on this classification. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information. + "isTokenizedDigitalAsset": True or False, # Whether this subscription is declared as a product representing a tokenized digital asset. + "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". + "a_key": { # Specified details about taxation in a given geographical region. + "eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in United States. + "streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax). + "taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498). + }, + }, + }, + }, + "updateMask": "A String", # Required. The list of fields to be updated. + }, + ], +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response message for BatchUpdateSubscription. + "subscriptions": [ # The updated subscriptions list. + { # A single subscription for an app. + "archived": True or False, # Output only. Whether this subscription is archived. Archived subscriptions are not available to any subscriber any longer, cannot be updated, and are not returned in list requests unless the show archived flag is passed in. + "basePlans": [ # The set of base plans for this subscription. Represents the prices and duration of the subscription if no other offers apply. + { # A single base plan for a subscription. + "autoRenewingBasePlanType": { # Represents a base plan that automatically renews at the end of its subscription period. # Set when the base plan automatically renews at a regular interval. + "billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. + "gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration. + "legacyCompatible": True or False, # Whether the renewing base plan is backward compatible. The backward compatible base plan is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one renewing base plan can be marked as legacy compatible for a given subscription. + "legacyCompatibleSubscriptionOfferId": "A String", # Subscription offer id which is legacy compatible. The backward compatible subscription offer is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one subscription offer can be marked as legacy compatible for a given renewing base plan. To have no Subscription offer as legacy compatible set this field as empty string. + "prorationMode": "A String", # The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE. + "resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified. + }, + "basePlanId": "A String", # Required. Immutable. The unique identifier of this base plan. Must be unique within the subscription, and conform with RFC-1034. That is, this ID can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 63 characters. + "offerTags": [ # List of up to 20 custom tags specified for this base plan, and returned to the app through the billing library. Subscription offers for this base plan will also receive these offer tags in the billing library. + { # Represents a custom tag specified for base plans and subscription offers. + "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters. + }, + ], + "otherRegionsConfig": { # Pricing information for any new locations Play may launch in. # Pricing information for any new locations Play may launch in the future. If omitted, the BasePlan will not be automatically available any new locations Play may launch in the future. + "eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new locations Play may launch in. + "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. + "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + }, + "newSubscriberAvailability": True or False, # Whether the base plan is available for new subscribers in any new locations Play may launch in. If not specified, this will default to false. + "usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new locations Play may launch in. + "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. + "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + }, + }, + "prepaidBasePlanType": { # Represents a base plan that does not automatically renew at the end of the base plan, and must be manually renewed by the user. # Set when the base plan does not automatically renew at the end of the billing period. + "billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. + "timeExtension": "A String", # Whether users should be able to extend this prepaid base plan in Google Play surfaces. Defaults to TIME_EXTENSION_ACTIVE if not specified. + }, + "regionalConfigs": [ # Region-specific information for this base plan. + { # Configuration for a base plan specific to a region. + "newSubscriberAvailability": True or False, # Whether the base plan in the specified region is available for new subscribers. Existing subscribers will not have their subscription canceled if this value is set to false. If not specified, this will default to false. + "price": { # Represents an amount of money with its currency type. # The price of the base plan in the specified region. Must be set if the base plan is available to new subscribers. Must be set in the currency that is linked to the specified region. + "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. + "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + }, + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + }, + ], + "state": "A String", # Output only. The state of the base plan, i.e. whether it's active. Draft and inactive base plans can be activated or deleted. Active base plans can be made inactive. Inactive base plans can be canceled. This field cannot be changed by updating the resource. Use the dedicated endpoints instead. + }, + ], + "listings": [ # Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app. + { # The consumer-visible metadata of a subscription. + "benefits": [ # A list of benefits shown to the user on platforms such as the Play Store and in restoration flows in the language of this listing. Plain text. Ordered list of at most four benefits. + "A String", + ], + "description": "A String", # The description of this subscription in the language of this listing. Maximum length - 80 characters. Plain text. + "languageCode": "A String", # Required. The language of this listing, as defined by BCP-47, e.g. "en-US". + "title": "A String", # Required. The title of this subscription in the language of this listing. Plain text. + }, + ], + "packageName": "A String", # Immutable. Package name of the parent app. + "productId": "A String", # Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length. + "taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for subscription products. # Details about taxes and legal compliance. + "eeaWithdrawalRightType": "A String", # Digital content or service classification for products distributed to users in the European Economic Area (EEA). The withdrawal regime under EEA consumer laws depends on this classification. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information. + "isTokenizedDigitalAsset": True or False, # Whether this subscription is declared as a product representing a tokenized digital asset. + "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". + "a_key": { # Specified details about taxation in a given geographical region. + "eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in United States. + "streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax). + "taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498). + }, + }, + }, + }, + ], +}+close()Close httplib2 connections.@@ -589,7 +871,7 @@Method Details
-+patch(packageName, productId, body=None, regionsVersion_version=None, updateMask=None, x__xgafv=None)+patch(packageName, productId, allowMissing=None, body=None, latencyTolerance=None, regionsVersion_version=None, updateMask=None, x__xgafv=None)Updates an existing subscription. Args: @@ -672,6 +954,12 @@Method Details
}, } + allowMissing: boolean, Optional. If set to true, and the subscription with the given package_name and product_id doesn't exist, the subscription will be created. If a new subscription is created, update_mask is ignored. + latencyTolerance: string, Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive. + Allowed values + PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED - Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE. + PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE - The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour. + PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT - The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods. regionsVersion_version: string, Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02. updateMask: string, Required. The list of fields to be updated. x__xgafv: string, V1 error format. diff --git a/docs/dyn/apphub_v1.html b/docs/dyn/apphub_v1.html new file mode 100644 index 00000000000..a58e94025b6 --- /dev/null +++ b/docs/dyn/apphub_v1.html @@ -0,0 +1,111 @@ + + + +App Hub API
+Instance Methods
++
+projects()+Returns the projects Resource.
+ ++
+close()Close httplib2 connections.
+ +Create a BatchHttpRequest object based on the discovery document.
+Method Details
+++ +close()+Close httplib2 connections.+++ + \ No newline at end of file diff --git a/docs/dyn/apphub_v1.projects.html b/docs/dyn/apphub_v1.projects.html new file mode 100644 index 00000000000..c17de401ae6 --- /dev/null +++ b/docs/dyn/apphub_v1.projects.html @@ -0,0 +1,91 @@ + + + +new_batch_http_request()+Create a BatchHttpRequest object based on the discovery document. + + Args: + callback: callable, A callback to be called for each response, of the + form callback(id, response, exception). The first parameter is the + request id, and the second is the deserialized response object. The + third is an apiclient.errors.HttpError exception object if an HTTP + error occurred while processing the request, or None if no error + occurred. + + Returns: + A BatchHttpRequest object based on the discovery document. ++App Hub API . projects
+Instance Methods
++
+locations()+Returns the locations Resource.
+ ++
+close()Close httplib2 connections.
+Method Details
+++ + \ No newline at end of file diff --git a/docs/dyn/apphub_v1.projects.locations.applications.html b/docs/dyn/apphub_v1.projects.locations.applications.html new file mode 100644 index 00000000000..e4868e39844 --- /dev/null +++ b/docs/dyn/apphub_v1.projects.locations.applications.html @@ -0,0 +1,258 @@ + + + +close()+Close httplib2 connections.+App Hub API . projects . locations . applications
+Instance Methods
++
+close()Close httplib2 connections.
++
+getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
++
+setIamPolicy(resource, body=None, x__xgafv=None)Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
++
+testIamPermissions(resource, body=None, x__xgafv=None)Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
+Method Details
+++ +close()+Close httplib2 connections.+++ +getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)+Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + +Args: + resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required) + options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. + "auditLogConfigs": [ # The configuration for logging of each type of permission. + { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. + "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. + "A String", + ], + "logType": "A String", # The log type that this config enables. + }, + ], + "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. + }, + ], + "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. + { # Associates `members`, or principals, with a `role`. + "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. + "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + }, + "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. + "A String", + ], + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + }, + ], + "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. + "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). +}+++ +setIamPolicy(resource, body=None, x__xgafv=None)+Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + +Args: + resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required) + body: object, The request body. + The object takes the form of: + +{ # Request message for `SetIamPolicy` method. + "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them. + "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. + "auditLogConfigs": [ # The configuration for logging of each type of permission. + { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. + "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. + "A String", + ], + "logType": "A String", # The log type that this config enables. + }, + ], + "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. + }, + ], + "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. + { # Associates `members`, or principals, with a `role`. + "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. + "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + }, + "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. + "A String", + ], + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + }, + ], + "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. + "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + }, + "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"` +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. + "auditLogConfigs": [ # The configuration for logging of each type of permission. + { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. + "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. + "A String", + ], + "logType": "A String", # The log type that this config enables. + }, + ], + "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. + }, + ], + "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. + { # Associates `members`, or principals, with a `role`. + "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. + "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + }, + "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. + "A String", + ], + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + }, + ], + "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. + "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). +}+++ + \ No newline at end of file diff --git a/docs/dyn/apphub_v1.projects.locations.html b/docs/dyn/apphub_v1.projects.locations.html new file mode 100644 index 00000000000..a06447ac2d8 --- /dev/null +++ b/docs/dyn/apphub_v1.projects.locations.html @@ -0,0 +1,181 @@ + + + +testIamPermissions(resource, body=None, x__xgafv=None)+Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + +Args: + resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required) + body: object, The request body. + The object takes the form of: + +{ # Request message for `TestIamPermissions` method. + "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + "A String", + ], +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response message for `TestIamPermissions` method. + "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. + "A String", + ], +}+App Hub API . projects . locations
+Instance Methods
++
+applications()+Returns the applications Resource.
+ ++
+operations()+Returns the operations Resource.
+ ++
+close()Close httplib2 connections.
+ +Gets information about a location.
++
+list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists information about the supported locations for this service.
+ +Retrieves the next page of results.
+Method Details
+++ +close()+Close httplib2 connections.+++ +get(name, x__xgafv=None)+Gets information about a location. + +Args: + name: string, Resource name for the location. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # A resource that represents a Google Cloud location. + "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo". + "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} + "a_key": "A String", + }, + "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`. + "metadata": { # Service-specific metadata. For example the available capacity at the given location. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` +}+++ +list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)+Lists information about the supported locations for this service. + +Args: + name: string, The resource that owns the locations collection, if applicable. (required) + filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. + pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # The response message for Locations.ListLocations. + "locations": [ # A list of locations that matches the specified filter in the request. + { # A resource that represents a Google Cloud location. + "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo". + "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} + "a_key": "A String", + }, + "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`. + "metadata": { # Service-specific metadata. For example the available capacity at the given location. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` + }, + ], + "nextPageToken": "A String", # The standard List next-page token. +}+++ + \ No newline at end of file diff --git a/docs/dyn/apphub_v1.projects.locations.operations.html b/docs/dyn/apphub_v1.projects.locations.operations.html new file mode 100644 index 00000000000..f04c7522f39 --- /dev/null +++ b/docs/dyn/apphub_v1.projects.locations.operations.html @@ -0,0 +1,235 @@ + + + +list_next()+Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++App Hub API . projects . locations . operations
+Instance Methods
++
+cancel(name, body=None, x__xgafv=None)Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
++
+close()Close httplib2 connections.
+ +Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+ +Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
++
+list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+ +Retrieves the next page of results.
+Method Details
+++ +cancel(name, body=None, x__xgafv=None)+Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + +Args: + name: string, The name of the operation resource to be cancelled. (required) + body: object, The request body. + The object takes the form of: + +{ # The request message for Operations.CancelOperation. +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } +}+++ +close()+Close httplib2 connections.+++ +delete(name, x__xgafv=None)+Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + +Args: + name: string, The name of the operation resource to be deleted. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } +}+++ +get(name, x__xgafv=None)+Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + +Args: + name: string, The name of the operation resource. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # This resource represents a long-running operation that is the result of a network API call. + "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + "error": { # 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). # The error result of the operation in case of failure or cancellation. + "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. + }, + "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. + "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, +}+++ +list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)+Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + +Args: + name: string, The name of the operation's parent resource. (required) + filter: string, The standard list filter. + pageSize: integer, The standard list page size. + pageToken: string, The standard list page token. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # The response message for Operations.ListOperations. + "nextPageToken": "A String", # The standard List next-page token. + "operations": [ # A list of operations that matches the specified filter in the request. + { # This resource represents a long-running operation that is the result of a network API call. + "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + "error": { # 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). # The error result of the operation in case of failure or cancellation. + "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. + }, + "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. + "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + }, + ], +}+++ + \ No newline at end of file diff --git a/docs/dyn/baremetalsolution_v2.projects.locations.instances.html b/docs/dyn/baremetalsolution_v2.projects.locations.instances.html index ca922b9a739..122bc928f1a 100644 --- a/docs/dyn/baremetalsolution_v2.projects.locations.instances.html +++ b/docs/dyn/baremetalsolution_v2.projects.locations.instances.html @@ -95,6 +95,9 @@list_next()+Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++Instance Methods
Retrieves the next page of results.
++
+loadAuthInfo(name, x__xgafv=None)Load auth info for a server.
patch(name, body=None, updateMask=None, x__xgafv=None)Update details of a single server.
@@ -261,6 +264,7 @@Method Details
"hyperthreadingEnabled": True or False, # True if you enable hyperthreading for the server, otherwise false. The default value is false. "id": "A String", # Output only. An identifier for the `Instance`, generated by the backend. "interactiveSerialConsoleEnabled": True or False, # Output only. True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false. + "kmsKeyVersion": "A String", # Optional. Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose. Format is `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}`. "labels": { # Labels as key value pairs. "a_key": "A String", }, @@ -291,7 +295,7 @@Method Details
"multiprotocolType": "A String", # The LUN multiprotocol type ensures the characteristics of the LUN are optimized for each operating system. "name": "A String", # Output only. The name of the LUN. "shareable": True or False, # Display if this LUN can be shared between multiple physical servers. - "sizeGb": "A String", # The size of this LUN, in gigabytes. + "sizeGb": "A String", # The size of this LUN, in GiB. "state": "A String", # The state of this storage volume. "storageType": "A String", # The storage type for this LUN. "storageVolume": "A String", # Display the storage volume for this LUN. @@ -360,6 +364,9 @@Method Details
], "osImage": "A String", # The OS image currently installed on the server. "pod": "A String", # Immutable. Pod name. Pod is an independent part of infrastructure. Instance can only be connected to the assets (networks, volumes) allocated in the same pod. + "sshKeys": [ # Optional. List of SSH Keys used during instance provisioning. + "A String", + ], "state": "A String", # Output only. The state of the server. "updateTime": "A String", # Output only. Update a time stamp. "volumes": [ # Input only. List of Volumes to attach to this Instance on creation. This field won't be populated in Get/List responses. @@ -428,6 +435,7 @@Method Details
"hyperthreadingEnabled": True or False, # True if you enable hyperthreading for the server, otherwise false. The default value is false. "id": "A String", # Output only. An identifier for the `Instance`, generated by the backend. "interactiveSerialConsoleEnabled": True or False, # Output only. True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false. + "kmsKeyVersion": "A String", # Optional. Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose. Format is `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}`. "labels": { # Labels as key value pairs. "a_key": "A String", }, @@ -458,7 +466,7 @@Method Details
"multiprotocolType": "A String", # The LUN multiprotocol type ensures the characteristics of the LUN are optimized for each operating system. "name": "A String", # Output only. The name of the LUN. "shareable": True or False, # Display if this LUN can be shared between multiple physical servers. - "sizeGb": "A String", # The size of this LUN, in gigabytes. + "sizeGb": "A String", # The size of this LUN, in GiB. "state": "A String", # The state of this storage volume. "storageType": "A String", # The storage type for this LUN. "storageVolume": "A String", # Display the storage volume for this LUN. @@ -527,6 +535,9 @@Method Details
], "osImage": "A String", # The OS image currently installed on the server. "pod": "A String", # Immutable. Pod name. Pod is an independent part of infrastructure. Instance can only be connected to the assets (networks, volumes) allocated in the same pod. + "sshKeys": [ # Optional. List of SSH Keys used during instance provisioning. + "A String", + ], "state": "A String", # Output only. The state of the server. "updateTime": "A String", # Output only. Update a time stamp. "volumes": [ # Input only. List of Volumes to attach to this Instance on creation. This field won't be populated in Get/List responses. @@ -590,6 +601,36 @@Method Details
++loadAuthInfo(name, x__xgafv=None)+Load auth info for a server. + +Args: + name: string, Required. Name of the server. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response for LoadInstanceAuthInfo. + "sshKeys": [ # List of ssh keys. + { # An SSH key, used for authorizing with the interactive serial console feature. + "name": "A String", # Output only. The name of this SSH key. Currently, the only valid value for the location is "global". + "publicKey": "A String", # The public SSH key. This must be in OpenSSH .authorized_keys format. + }, + ], + "userAccounts": { # Map of username to the user account info. + "a_key": { # User account provisioned for the customer. + "encryptedPassword": "A String", # Encrypted initial password value. + "kmsKeyVersion": "A String", # KMS CryptoKey Version used to encrypt the password. + }, + }, +}+@@ -173,7 +173,7 @@patch(name, body=None, updateMask=None, x__xgafv=None)Update details of a single server. @@ -605,6 +646,7 @@Method Details
"hyperthreadingEnabled": True or False, # True if you enable hyperthreading for the server, otherwise false. The default value is false. "id": "A String", # Output only. An identifier for the `Instance`, generated by the backend. "interactiveSerialConsoleEnabled": True or False, # Output only. True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false. + "kmsKeyVersion": "A String", # Optional. Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose. Format is `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}`. "labels": { # Labels as key value pairs. "a_key": "A String", }, @@ -635,7 +677,7 @@Method Details
"multiprotocolType": "A String", # The LUN multiprotocol type ensures the characteristics of the LUN are optimized for each operating system. "name": "A String", # Output only. The name of the LUN. "shareable": True or False, # Display if this LUN can be shared between multiple physical servers. - "sizeGb": "A String", # The size of this LUN, in gigabytes. + "sizeGb": "A String", # The size of this LUN, in GiB. "state": "A String", # The state of this storage volume. "storageType": "A String", # The storage type for this LUN. "storageVolume": "A String", # Display the storage volume for this LUN. @@ -704,6 +746,9 @@Method Details
], "osImage": "A String", # The OS image currently installed on the server. "pod": "A String", # Immutable. Pod name. Pod is an independent part of infrastructure. Instance can only be connected to the assets (networks, volumes) allocated in the same pod. + "sshKeys": [ # Optional. List of SSH Keys used during instance provisioning. + "A String", + ], "state": "A String", # Output only. The state of the server. "updateTime": "A String", # Output only. Update a time stamp. "volumes": [ # Input only. List of Volumes to attach to this Instance on creation. This field won't be populated in Get/List responses. @@ -803,6 +848,7 @@Method Details
"hyperthreadingEnabled": True or False, # True if you enable hyperthreading for the server, otherwise false. The default value is false. "id": "A String", # Output only. An identifier for the `Instance`, generated by the backend. "interactiveSerialConsoleEnabled": True or False, # Output only. True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false. + "kmsKeyVersion": "A String", # Optional. Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose. Format is `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}`. "labels": { # Labels as key value pairs. "a_key": "A String", }, @@ -833,7 +879,7 @@Method Details
"multiprotocolType": "A String", # The LUN multiprotocol type ensures the characteristics of the LUN are optimized for each operating system. "name": "A String", # Output only. The name of the LUN. "shareable": True or False, # Display if this LUN can be shared between multiple physical servers. - "sizeGb": "A String", # The size of this LUN, in gigabytes. + "sizeGb": "A String", # The size of this LUN, in GiB. "state": "A String", # The state of this storage volume. "storageType": "A String", # The storage type for this LUN. "storageVolume": "A String", # Display the storage volume for this LUN. @@ -902,6 +948,9 @@Method Details
], "osImage": "A String", # The OS image currently installed on the server. "pod": "A String", # Immutable. Pod name. Pod is an independent part of infrastructure. Instance can only be connected to the assets (networks, volumes) allocated in the same pod. + "sshKeys": [ # Optional. List of SSH Keys used during instance provisioning. + "A String", + ], "state": "A String", # Output only. The state of the server. "updateTime": "A String", # Output only. Update a time stamp. "volumes": [ # Input only. List of Volumes to attach to this Instance on creation. This field won't be populated in Get/List responses. diff --git a/docs/dyn/baremetalsolution_v2.projects.locations.provisioningConfigs.html b/docs/dyn/baremetalsolution_v2.projects.locations.provisioningConfigs.html index 02959874c0d..99f77ec8523 100644 --- a/docs/dyn/baremetalsolution_v2.projects.locations.provisioningConfigs.html +++ b/docs/dyn/baremetalsolution_v2.projects.locations.provisioningConfigs.html @@ -120,6 +120,7 @@Method Details
"hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled. "id": "A String", # A transient unique identifier to idenfity an instance within an ProvisioningConfig request. "instanceType": "A String", # Instance type. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) + "kmsKeyVersion": "A String", # Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose. "logicalInterfaces": [ # List of logical interfaces for the instance. The number of logical interfaces will be the same as number of hardware bond/nic on the chosen network template. Filled if InstanceConfig.multivlan_config is true. { # Each logical interface represents a logical abstraction of the underlying physical interface (for eg. bond, nic) of the instance. Each logical interface can effectively map to multiple network-IP pairs and still be mapped to one underlying physical interface. "interfaceIndex": 42, # The index of the logical interface mapping to the index of the hardware bond or nic on the chosen network template. This field is deprecated. @@ -238,6 +239,7 @@Method Details
"hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled. "id": "A String", # A transient unique identifier to idenfity an instance within an ProvisioningConfig request. "instanceType": "A String", # Instance type. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) + "kmsKeyVersion": "A String", # Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose. "logicalInterfaces": [ # List of logical interfaces for the instance. The number of logical interfaces will be the same as number of hardware bond/nic on the chosen network template. Filled if InstanceConfig.multivlan_config is true. { # Each logical interface represents a logical abstraction of the underlying physical interface (for eg. bond, nic) of the instance. Each logical interface can effectively map to multiple network-IP pairs and still be mapped to one underlying physical interface. "interfaceIndex": 42, # The index of the logical interface mapping to the index of the hardware bond or nic on the chosen network template. This field is deprecated. @@ -362,6 +364,7 @@Method Details
"hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled. "id": "A String", # A transient unique identifier to idenfity an instance within an ProvisioningConfig request. "instanceType": "A String", # Instance type. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) + "kmsKeyVersion": "A String", # Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose. "logicalInterfaces": [ # List of logical interfaces for the instance. The number of logical interfaces will be the same as number of hardware bond/nic on the chosen network template. Filled if InstanceConfig.multivlan_config is true. { # Each logical interface represents a logical abstraction of the underlying physical interface (for eg. bond, nic) of the instance. Each logical interface can effectively map to multiple network-IP pairs and still be mapped to one underlying physical interface. "interfaceIndex": 42, # The index of the logical interface mapping to the index of the hardware bond or nic on the chosen network template. This field is deprecated. @@ -481,6 +484,7 @@Method Details
"hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled. "id": "A String", # A transient unique identifier to idenfity an instance within an ProvisioningConfig request. "instanceType": "A String", # Instance type. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) + "kmsKeyVersion": "A String", # Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose. "logicalInterfaces": [ # List of logical interfaces for the instance. The number of logical interfaces will be the same as number of hardware bond/nic on the chosen network template. Filled if InstanceConfig.multivlan_config is true. { # Each logical interface represents a logical abstraction of the underlying physical interface (for eg. bond, nic) of the instance. Each logical interface can effectively map to multiple network-IP pairs and still be mapped to one underlying physical interface. "interfaceIndex": 42, # The index of the logical interface mapping to the index of the hardware bond or nic on the chosen network template. This field is deprecated. @@ -600,6 +604,7 @@Method Details
"hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled. "id": "A String", # A transient unique identifier to idenfity an instance within an ProvisioningConfig request. "instanceType": "A String", # Instance type. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) + "kmsKeyVersion": "A String", # Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose. "logicalInterfaces": [ # List of logical interfaces for the instance. The number of logical interfaces will be the same as number of hardware bond/nic on the chosen network template. Filled if InstanceConfig.multivlan_config is true. { # Each logical interface represents a logical abstraction of the underlying physical interface (for eg. bond, nic) of the instance. Each logical interface can effectively map to multiple network-IP pairs and still be mapped to one underlying physical interface. "interfaceIndex": 42, # The index of the logical interface mapping to the index of the hardware bond or nic on the chosen network template. This field is deprecated. @@ -721,6 +726,7 @@Method Details
"hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled. "id": "A String", # A transient unique identifier to idenfity an instance within an ProvisioningConfig request. "instanceType": "A String", # Instance type. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) + "kmsKeyVersion": "A String", # Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose. "logicalInterfaces": [ # List of logical interfaces for the instance. The number of logical interfaces will be the same as number of hardware bond/nic on the chosen network template. Filled if InstanceConfig.multivlan_config is true. { # Each logical interface represents a logical abstraction of the underlying physical interface (for eg. bond, nic) of the instance. Each logical interface can effectively map to multiple network-IP pairs and still be mapped to one underlying physical interface. "interfaceIndex": 42, # The index of the logical interface mapping to the index of the hardware bond or nic on the chosen network template. This field is deprecated. @@ -840,6 +846,7 @@Method Details
"hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled. "id": "A String", # A transient unique identifier to idenfity an instance within an ProvisioningConfig request. "instanceType": "A String", # Instance type. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) + "kmsKeyVersion": "A String", # Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose. "logicalInterfaces": [ # List of logical interfaces for the instance. The number of logical interfaces will be the same as number of hardware bond/nic on the chosen network template. Filled if InstanceConfig.multivlan_config is true. { # Each logical interface represents a logical abstraction of the underlying physical interface (for eg. bond, nic) of the instance. Each logical interface can effectively map to multiple network-IP pairs and still be mapped to one underlying physical interface. "interfaceIndex": 42, # The index of the logical interface mapping to the index of the hardware bond or nic on the chosen network template. This field is deprecated. diff --git a/docs/dyn/baremetalsolution_v2.projects.locations.volumes.luns.html b/docs/dyn/baremetalsolution_v2.projects.locations.volumes.luns.html index 3b025ee304c..cea3d93b144 100644 --- a/docs/dyn/baremetalsolution_v2.projects.locations.volumes.luns.html +++ b/docs/dyn/baremetalsolution_v2.projects.locations.volumes.luns.html @@ -160,7 +160,7 @@Method Details
"multiprotocolType": "A String", # The LUN multiprotocol type ensures the characteristics of the LUN are optimized for each operating system. "name": "A String", # Output only. The name of the LUN. "shareable": True or False, # Display if this LUN can be shared between multiple physical servers. - "sizeGb": "A String", # The size of this LUN, in gigabytes. + "sizeGb": "A String", # The size of this LUN, in GiB. "state": "A String", # The state of this storage volume. "storageType": "A String", # The storage type for this LUN. "storageVolume": "A String", # Display the storage volume for this LUN. @@ -196,7 +196,7 @@Method Details
"multiprotocolType": "A String", # The LUN multiprotocol type ensures the characteristics of the LUN are optimized for each operating system. "name": "A String", # Output only. The name of the LUN. "shareable": True or False, # Display if this LUN can be shared between multiple physical servers. - "sizeGb": "A String", # The size of this LUN, in gigabytes. + "sizeGb": "A String", # The size of this LUN, in GiB. "state": "A String", # The state of this storage volume. "storageType": "A String", # The storage type for this LUN. "storageVolume": "A String", # Display the storage volume for this LUN. diff --git a/docs/dyn/batch_v1.projects.locations.jobs.html b/docs/dyn/batch_v1.projects.locations.jobs.html index 73cfbe03485..78613010760 100644 --- a/docs/dyn/batch_v1.projects.locations.jobs.html +++ b/docs/dyn/batch_v1.projects.locations.jobs.html @@ -187,8 +187,6 @@Method Details
"a_key": "A String", }, "logsPolicy": { # LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be preserved. # Log preservation policy for the Job. - "cloudLoggingOption": { # CloudLoggingOption contains additional settings for cloud logging generated by Batch job. # Optional. Additional settings for Cloud Logging. It will only take effect when the destination of LogsPolicy is set to CLOUD_LOGGING. - }, "destination": "A String", # Where logs should be saved. "logsPath": "A String", # The path to which logs are saved when the destination = PATH. This can be a local file path on the VM, or under the mount point of a Persistent Disk or Filestore, or a Cloud Storage path. }, @@ -308,6 +306,7 @@Method Details
"commands": [ # Overrides the `CMD` specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then commands are appended as arguments to the ENTRYPOINT. "A String", ], + "enableImageStreaming": True or False, # Optional. If set to true, container will run with Image streaming. The container runtime will be changed to containerd instead of docker. Currently, only imageUri, commands, entrypoint and volumes are supported and any other fields will be ignored. Please refer [here](https://github.com/GoogleCloudPlatform/batch-samples/tree/main/api-samples/image-streaming) for the feature requirements and limitations. "entrypoint": "A String", # Overrides the `ENTRYPOINT` specified in the container. "imageUri": "A String", # The URI to pull the container image from. "options": "A String", # Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host". @@ -449,8 +448,6 @@Method Details
"a_key": "A String", }, "logsPolicy": { # LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be preserved. # Log preservation policy for the Job. - "cloudLoggingOption": { # CloudLoggingOption contains additional settings for cloud logging generated by Batch job. # Optional. Additional settings for Cloud Logging. It will only take effect when the destination of LogsPolicy is set to CLOUD_LOGGING. - }, "destination": "A String", # Where logs should be saved. "logsPath": "A String", # The path to which logs are saved when the destination = PATH. This can be a local file path on the VM, or under the mount point of a Persistent Disk or Filestore, or a Cloud Storage path. }, @@ -570,6 +567,7 @@Method Details
"commands": [ # Overrides the `CMD` specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then commands are appended as arguments to the ENTRYPOINT. "A String", ], + "enableImageStreaming": True or False, # Optional. If set to true, container will run with Image streaming. The container runtime will be changed to containerd instead of docker. Currently, only imageUri, commands, entrypoint and volumes are supported and any other fields will be ignored. Please refer [here](https://github.com/GoogleCloudPlatform/batch-samples/tree/main/api-samples/image-streaming) for the feature requirements and limitations. "entrypoint": "A String", # Overrides the `ENTRYPOINT` specified in the container. "imageUri": "A String", # The URI to pull the container image from. "options": "A String", # Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host". @@ -753,8 +751,6 @@Method Details
"a_key": "A String", }, "logsPolicy": { # LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be preserved. # Log preservation policy for the Job. - "cloudLoggingOption": { # CloudLoggingOption contains additional settings for cloud logging generated by Batch job. # Optional. Additional settings for Cloud Logging. It will only take effect when the destination of LogsPolicy is set to CLOUD_LOGGING. - }, "destination": "A String", # Where logs should be saved. "logsPath": "A String", # The path to which logs are saved when the destination = PATH. This can be a local file path on the VM, or under the mount point of a Persistent Disk or Filestore, or a Cloud Storage path. }, @@ -874,6 +870,7 @@Method Details
"commands": [ # Overrides the `CMD` specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then commands are appended as arguments to the ENTRYPOINT. "A String", ], + "enableImageStreaming": True or False, # Optional. If set to true, container will run with Image streaming. The container runtime will be changed to containerd instead of docker. Currently, only imageUri, commands, entrypoint and volumes are supported and any other fields will be ignored. Please refer [here](https://github.com/GoogleCloudPlatform/batch-samples/tree/main/api-samples/image-streaming) for the feature requirements and limitations. "entrypoint": "A String", # Overrides the `ENTRYPOINT` specified in the container. "imageUri": "A String", # The URI to pull the container image from. "options": "A String", # Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host". @@ -1026,8 +1023,6 @@Method Details
"a_key": "A String", }, "logsPolicy": { # LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be preserved. # Log preservation policy for the Job. - "cloudLoggingOption": { # CloudLoggingOption contains additional settings for cloud logging generated by Batch job. # Optional. Additional settings for Cloud Logging. It will only take effect when the destination of LogsPolicy is set to CLOUD_LOGGING. - }, "destination": "A String", # Where logs should be saved. "logsPath": "A String", # The path to which logs are saved when the destination = PATH. This can be a local file path on the VM, or under the mount point of a Persistent Disk or Filestore, or a Cloud Storage path. }, @@ -1147,6 +1142,7 @@Method Details
"commands": [ # Overrides the `CMD` specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then commands are appended as arguments to the ENTRYPOINT. "A String", ], + "enableImageStreaming": True or False, # Optional. If set to true, container will run with Image streaming. The container runtime will be changed to containerd instead of docker. Currently, only imageUri, commands, entrypoint and volumes are supported and any other fields will be ignored. Please refer [here](https://github.com/GoogleCloudPlatform/batch-samples/tree/main/api-samples/image-streaming) for the feature requirements and limitations. "entrypoint": "A String", # Overrides the `ENTRYPOINT` specified in the container. "imageUri": "A String", # The URI to pull the container image from. "options": "A String", # Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host". diff --git a/docs/dyn/batch_v1.projects.locations.state.html b/docs/dyn/batch_v1.projects.locations.state.html index 448b48fc6ca..cb58c99ec92 100644 --- a/docs/dyn/batch_v1.projects.locations.state.html +++ b/docs/dyn/batch_v1.projects.locations.state.html @@ -256,6 +256,7 @@Method Details
"commands": [ # Overrides the `CMD` specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then commands are appended as arguments to the ENTRYPOINT. "A String", ], + "enableImageStreaming": True or False, # Optional. If set to true, container will run with Image streaming. The container runtime will be changed to containerd instead of docker. Currently, only imageUri, commands, entrypoint and volumes are supported and any other fields will be ignored. Please refer [here](https://github.com/GoogleCloudPlatform/batch-samples/tree/main/api-samples/image-streaming) for the feature requirements and limitations. "entrypoint": "A String", # Overrides the `ENTRYPOINT` specified in the container. "imageUri": "A String", # The URI to pull the container image from. "options": "A String", # Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host". diff --git a/docs/dyn/bigquery_v2.models.html b/docs/dyn/bigquery_v2.models.html index 608a360819a..e9dbd9bf7ea 100644 --- a/docs/dyn/bigquery_v2.models.html +++ b/docs/dyn/bigquery_v2.models.html @@ -801,6 +801,7 @@Method Details
"maxBatchingRows": "A String", # Output only. Max number of rows in each batch sent to the remote service. If unset, the number of rows in each batch is set dynamically. "remoteModelVersion": "A String", # Output only. The model version for LLM. "remoteServiceType": "A String", # Output only. The remote service type for remote model. + "speechRecognizer": "A String", # Output only. The name of the speech recognizer to use for speech recognition. The expected format is `projects/{project}/locations/{location}/recognizers/{recognizer}`. Customers can specify this field at model creation. If not specified, a default recognizer `projects/{model project}/locations/global/recognizers/_` will be used. See more details at [recognizers](https://cloud.google.com/speech-to-text/v2/docs/reference/rest/v2/projects.locations.recognizers) }, "trainingRuns": [ # Information for all training runs in increasing order of start_time. { # Information about a single training query run for the model. @@ -1821,6 +1822,7 @@Method Details
"maxBatchingRows": "A String", # Output only. Max number of rows in each batch sent to the remote service. If unset, the number of rows in each batch is set dynamically. "remoteModelVersion": "A String", # Output only. The model version for LLM. "remoteServiceType": "A String", # Output only. The remote service type for remote model. + "speechRecognizer": "A String", # Output only. The name of the speech recognizer to use for speech recognition. The expected format is `projects/{project}/locations/{location}/recognizers/{recognizer}`. Customers can specify this field at model creation. If not specified, a default recognizer `projects/{model project}/locations/global/recognizers/_` will be used. See more details at [recognizers](https://cloud.google.com/speech-to-text/v2/docs/reference/rest/v2/projects.locations.recognizers) }, "trainingRuns": [ # Information for all training runs in increasing order of start_time. { # Information about a single training query run for the model. @@ -2854,6 +2856,7 @@Method Details
"maxBatchingRows": "A String", # Output only. Max number of rows in each batch sent to the remote service. If unset, the number of rows in each batch is set dynamically. "remoteModelVersion": "A String", # Output only. The model version for LLM. "remoteServiceType": "A String", # Output only. The remote service type for remote model. + "speechRecognizer": "A String", # Output only. The name of the speech recognizer to use for speech recognition. The expected format is `projects/{project}/locations/{location}/recognizers/{recognizer}`. Customers can specify this field at model creation. If not specified, a default recognizer `projects/{model project}/locations/global/recognizers/_` will be used. See more details at [recognizers](https://cloud.google.com/speech-to-text/v2/docs/reference/rest/v2/projects.locations.recognizers) }, "trainingRuns": [ # Information for all training runs in increasing order of start_time. { # Information about a single training query run for the model. @@ -3862,6 +3865,7 @@Method Details
"maxBatchingRows": "A String", # Output only. Max number of rows in each batch sent to the remote service. If unset, the number of rows in each batch is set dynamically. "remoteModelVersion": "A String", # Output only. The model version for LLM. "remoteServiceType": "A String", # Output only. The remote service type for remote model. + "speechRecognizer": "A String", # Output only. The name of the speech recognizer to use for speech recognition. The expected format is `projects/{project}/locations/{location}/recognizers/{recognizer}`. Customers can specify this field at model creation. If not specified, a default recognizer `projects/{model project}/locations/global/recognizers/_` will be used. See more details at [recognizers](https://cloud.google.com/speech-to-text/v2/docs/reference/rest/v2/projects.locations.recognizers) }, "trainingRuns": [ # Information for all training runs in increasing order of start_time. { # Information about a single training query run for the model. diff --git a/docs/dyn/cloudbilling_v1.billingAccounts.html b/docs/dyn/cloudbilling_v1.billingAccounts.html index 59f2abbda34..cc749a049f8 100644 --- a/docs/dyn/cloudbilling_v1.billingAccounts.html +++ b/docs/dyn/cloudbilling_v1.billingAccounts.html @@ -133,10 +133,10 @@Method Details
"masterBillingAccount": "A String", # If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty. "name": "A String", # Output only. The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`. "open": True or False, # Output only. True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it will be unable to use paid services. - "parent": "A String", # Output only. The billing account's parent resource identifier. Use the `MoveBillingAccount` method to update the account's parent resource if it is a organization. Format: - organizations/{organization_id}, for example: organizations/12345678 - billingAccounts/{billing_account_id}, for example: `billingAccounts/012345-567890-ABCDEF` + "parent": "A String", # Output only. The billing account's parent resource identifier. Use the `MoveBillingAccount` method to update the account's parent resource if it is a organization. Format: - `organizations/{organization_id}`, for example, `organizations/12345678` - `billingAccounts/{billing_account_id}`, for example, `billingAccounts/012345-567890-ABCDEF` } - parent: string, Optional. The parent to create a billing account from. Format: - organizations/{organization_id} eg organizations/12345678 - billingAccounts/{billing_account_id} eg `billingAccounts/012345-567890-ABCDEF` + parent: string, Optional. The parent to create a billing account from. Format: - `organizations/{organization_id}`, for example, `organizations/12345678` - `billingAccounts/{billing_account_id}`, for example, `billingAccounts/012345-567890-ABCDEF` x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -150,7 +150,7 @@Method Details
"masterBillingAccount": "A String", # If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty. "name": "A String", # Output only. The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`. "open": True or False, # Output only. True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it will be unable to use paid services. - "parent": "A String", # Output only. The billing account's parent resource identifier. Use the `MoveBillingAccount` method to update the account's parent resource if it is a organization. Format: - organizations/{organization_id}, for example: organizations/12345678 - billingAccounts/{billing_account_id}, for example: `billingAccounts/012345-567890-ABCDEF` + "parent": "A String", # Output only. The billing account's parent resource identifier. Use the `MoveBillingAccount` method to update the account's parent resource if it is a organization. Format: - `organizations/{organization_id}`, for example, `organizations/12345678` - `billingAccounts/{billing_account_id}`, for example, `billingAccounts/012345-567890-ABCDEF` }Method Details
"masterBillingAccount": "A String", # If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty. "name": "A String", # Output only. The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`. "open": True or False, # Output only. True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it will be unable to use paid services. - "parent": "A String", # Output only. The billing account's parent resource identifier. Use the `MoveBillingAccount` method to update the account's parent resource if it is a organization. Format: - organizations/{organization_id}, for example: organizations/12345678 - billingAccounts/{billing_account_id}, for example: `billingAccounts/012345-567890-ABCDEF` + "parent": "A String", # Output only. The billing account's parent resource identifier. Use the `MoveBillingAccount` method to update the account's parent resource if it is a organization. Format: - `organizations/{organization_id}`, for example, `organizations/12345678` - `billingAccounts/{billing_account_id}`, for example, `billingAccounts/012345-567890-ABCDEF` }
Lists the billing accounts that the current authenticated user has permission to [view](https://cloud.google.com/billing/docs/how-to/billing-access).
Args:
- filter: string, Options for how to filter the returned billing accounts. This only supports filtering for [subaccounts](https://cloud.google.com/billing/docs/concepts) under a single provided parent billing account. (e.g. "master_billing_account=billingAccounts/012345-678901-ABCDEF"). Boolean algebra and other fields are not currently supported.
+ filter: string, Options for how to filter the returned billing accounts. This only supports filtering for [subaccounts](https://cloud.google.com/billing/docs/concepts) under a single provided parent billing account. (for example, `master_billing_account=billingAccounts/012345-678901-ABCDEF`). Boolean algebra and other fields are not currently supported.
pageSize: integer, Requested page size. The maximum page size is 100; this is also the default.
pageToken: string, A token identifying a page of results to return. This should be a `next_page_token` value returned from a previous `ListBillingAccounts` call. If unspecified, the first page of results is returned.
- parent: string, Optional. The parent resource to list billing accounts from. Format: - organizations/{organization_id} eg organizations/12345678 - billingAccounts/{billing_account_id} eg `billingAccounts/012345-567890-ABCDEF`
+ parent: string, Optional. The parent resource to list billing accounts from. Format: - `organizations/{organization_id}`, for example, `organizations/12345678` - `billingAccounts/{billing_account_id}`, for example, `billingAccounts/012345-567890-ABCDEF`
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -249,7 +249,7 @@ Method Details
"masterBillingAccount": "A String", # If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty.
"name": "A String", # Output only. The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`.
"open": True or False, # Output only. True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it will be unable to use paid services.
- "parent": "A String", # Output only. The billing account's parent resource identifier. Use the `MoveBillingAccount` method to update the account's parent resource if it is a organization. Format: - organizations/{organization_id}, for example: organizations/12345678 - billingAccounts/{billing_account_id}, for example: `billingAccounts/012345-567890-ABCDEF`
+ "parent": "A String", # Output only. The billing account's parent resource identifier. Use the `MoveBillingAccount` method to update the account's parent resource if it is a organization. Format: - `organizations/{organization_id}`, for example, `organizations/12345678` - `billingAccounts/{billing_account_id}`, for example, `billingAccounts/012345-567890-ABCDEF`
},
],
"nextPageToken": "A String", # A token to retrieve the next page of results. To retrieve the next page, call `ListBillingAccounts` again with the `page_token` field set to this value. This field is empty if there are no more results to retrieve.
@@ -296,7 +296,7 @@ Method Details
"masterBillingAccount": "A String", # If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty.
"name": "A String", # Output only. The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`.
"open": True or False, # Output only. True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it will be unable to use paid services.
- "parent": "A String", # Output only. The billing account's parent resource identifier. Use the `MoveBillingAccount` method to update the account's parent resource if it is a organization. Format: - organizations/{organization_id}, for example: organizations/12345678 - billingAccounts/{billing_account_id}, for example: `billingAccounts/012345-567890-ABCDEF`
+ "parent": "A String", # Output only. The billing account's parent resource identifier. Use the `MoveBillingAccount` method to update the account's parent resource if it is a organization. Format: - `organizations/{organization_id}`, for example, `organizations/12345678` - `billingAccounts/{billing_account_id}`, for example, `billingAccounts/012345-567890-ABCDEF`
}
This method creates [billing subaccounts](https://cloud.google.com/billing/docs/concepts#subaccounts). Google Cloud resellers should use the Channel Services APIs, [accounts.customers.create](https://cloud.google.com/channel/docs/reference/rest/v1/accounts.customers/create) and [accounts.customers.entitlements.create](https://cloud.google.com/channel/docs/reference/rest/v1/accounts.customers.entitlements/create). When creating a subaccount, the current authenticated user must have the `billing.accounts.update` IAM permission on the parent account, which is typically given to billing account [administrators](https://cloud.google.com/billing/docs/how-to/billing-access). This method will return an error if the parent account has not been provisioned for subaccounts.
Args:
- parent: string, Optional. The parent to create a billing account from. Format: - organizations/{organization_id} eg organizations/12345678 - billingAccounts/{billing_account_id} eg `billingAccounts/012345-567890-ABCDEF` (required)
+ parent: string, Optional. The parent to create a billing account from. Format: - `organizations/{organization_id}`, for example, `organizations/12345678` - `billingAccounts/{billing_account_id}`, for example, `billingAccounts/012345-567890-ABCDEF` (required)
body: object, The request body.
The object takes the form of:
@@ -106,7 +106,7 @@ Method Details
"masterBillingAccount": "A String", # If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty.
"name": "A String", # Output only. The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`.
"open": True or False, # Output only. True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it will be unable to use paid services.
- "parent": "A String", # Output only. The billing account's parent resource identifier. Use the `MoveBillingAccount` method to update the account's parent resource if it is a organization. Format: - organizations/{organization_id}, for example: organizations/12345678 - billingAccounts/{billing_account_id}, for example: `billingAccounts/012345-567890-ABCDEF`
+ "parent": "A String", # Output only. The billing account's parent resource identifier. Use the `MoveBillingAccount` method to update the account's parent resource if it is a organization. Format: - `organizations/{organization_id}`, for example, `organizations/12345678` - `billingAccounts/{billing_account_id}`, for example, `billingAccounts/012345-567890-ABCDEF`
}
x__xgafv: string, V1 error format.
@@ -122,7 +122,7 @@ Method Details
"masterBillingAccount": "A String", # If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty.
"name": "A String", # Output only. The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`.
"open": True or False, # Output only. True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it will be unable to use paid services.
- "parent": "A String", # Output only. The billing account's parent resource identifier. Use the `MoveBillingAccount` method to update the account's parent resource if it is a organization. Format: - organizations/{organization_id}, for example: organizations/12345678 - billingAccounts/{billing_account_id}, for example: `billingAccounts/012345-567890-ABCDEF`
+ "parent": "A String", # Output only. The billing account's parent resource identifier. Use the `MoveBillingAccount` method to update the account's parent resource if it is a organization. Format: - `organizations/{organization_id}`, for example, `organizations/12345678` - `billingAccounts/{billing_account_id}`, for example, `billingAccounts/012345-567890-ABCDEF`
}
@@ -131,8 +131,8 @@ Lists the billing accounts that the current authenticated user has permission to [view](https://cloud.google.com/billing/docs/how-to/billing-access).
Args:
- parent: string, Optional. The parent resource to list billing accounts from. Format: - organizations/{organization_id} eg organizations/12345678 - billingAccounts/{billing_account_id} eg `billingAccounts/012345-567890-ABCDEF` (required)
- filter: string, Options for how to filter the returned billing accounts. This only supports filtering for [subaccounts](https://cloud.google.com/billing/docs/concepts) under a single provided parent billing account. (e.g. "master_billing_account=billingAccounts/012345-678901-ABCDEF"). Boolean algebra and other fields are not currently supported.
+ parent: string, Optional. The parent resource to list billing accounts from. Format: - `organizations/{organization_id}`, for example, `organizations/12345678` - `billingAccounts/{billing_account_id}`, for example, `billingAccounts/012345-567890-ABCDEF` (required)
+ filter: string, Options for how to filter the returned billing accounts. This only supports filtering for [subaccounts](https://cloud.google.com/billing/docs/concepts) under a single provided parent billing account. (for example, `master_billing_account=billingAccounts/012345-678901-ABCDEF`). Boolean algebra and other fields are not currently supported.
pageSize: integer, Requested page size. The maximum page size is 100; this is also the default.
pageToken: string, A token identifying a page of results to return. This should be a `next_page_token` value returned from a previous `ListBillingAccounts` call. If unspecified, the first page of results is returned.
x__xgafv: string, V1 error format.
@@ -150,7 +150,7 @@ Method Details
"masterBillingAccount": "A String", # If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty.
"name": "A String", # Output only. The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`.
"open": True or False, # Output only. True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it will be unable to use paid services.
- "parent": "A String", # Output only. The billing account's parent resource identifier. Use the `MoveBillingAccount` method to update the account's parent resource if it is a organization. Format: - organizations/{organization_id}, for example: organizations/12345678 - billingAccounts/{billing_account_id}, for example: `billingAccounts/012345-567890-ABCDEF`
+ "parent": "A String", # Output only. The billing account's parent resource identifier. Use the `MoveBillingAccount` method to update the account's parent resource if it is a organization. Format: - `organizations/{organization_id}`, for example, `organizations/12345678` - `billingAccounts/{billing_account_id}`, for example, `billingAccounts/012345-567890-ABCDEF`
},
],
"nextPageToken": "A String", # A token to retrieve the next page of results. To retrieve the next page, call `ListBillingAccounts` again with the `page_token` field set to this value. This field is empty if there are no more results to retrieve.
diff --git a/docs/dyn/cloudbilling_v1.organizations.billingAccounts.html b/docs/dyn/cloudbilling_v1.organizations.billingAccounts.html
index 0ff45d23ac1..b79571c85e6 100644
--- a/docs/dyn/cloudbilling_v1.organizations.billingAccounts.html
+++ b/docs/dyn/cloudbilling_v1.organizations.billingAccounts.html
@@ -100,7 +100,7 @@ Method Details
This method creates [billing subaccounts](https://cloud.google.com/billing/docs/concepts#subaccounts). Google Cloud resellers should use the Channel Services APIs, [accounts.customers.create](https://cloud.google.com/channel/docs/reference/rest/v1/accounts.customers/create) and [accounts.customers.entitlements.create](https://cloud.google.com/channel/docs/reference/rest/v1/accounts.customers.entitlements/create). When creating a subaccount, the current authenticated user must have the `billing.accounts.update` IAM permission on the parent account, which is typically given to billing account [administrators](https://cloud.google.com/billing/docs/how-to/billing-access). This method will return an error if the parent account has not been provisioned for subaccounts.
Args:
- parent: string, Optional. The parent to create a billing account from. Format: - organizations/{organization_id} eg organizations/12345678 - billingAccounts/{billing_account_id} eg `billingAccounts/012345-567890-ABCDEF` (required)
+ parent: string, Optional. The parent to create a billing account from. Format: - `organizations/{organization_id}`, for example, `organizations/12345678` - `billingAccounts/{billing_account_id}`, for example, `billingAccounts/012345-567890-ABCDEF` (required)
body: object, The request body.
The object takes the form of:
@@ -109,7 +109,7 @@ Method Details
"masterBillingAccount": "A String", # If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty.
"name": "A String", # Output only. The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`.
"open": True or False, # Output only. True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it will be unable to use paid services.
- "parent": "A String", # Output only. The billing account's parent resource identifier. Use the `MoveBillingAccount` method to update the account's parent resource if it is a organization. Format: - organizations/{organization_id}, for example: organizations/12345678 - billingAccounts/{billing_account_id}, for example: `billingAccounts/012345-567890-ABCDEF`
+ "parent": "A String", # Output only. The billing account's parent resource identifier. Use the `MoveBillingAccount` method to update the account's parent resource if it is a organization. Format: - `organizations/{organization_id}`, for example, `organizations/12345678` - `billingAccounts/{billing_account_id}`, for example, `billingAccounts/012345-567890-ABCDEF`
}
x__xgafv: string, V1 error format.
@@ -125,7 +125,7 @@ Method Details
"masterBillingAccount": "A String", # If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty.
"name": "A String", # Output only. The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`.
"open": True or False, # Output only. True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it will be unable to use paid services.
- "parent": "A String", # Output only. The billing account's parent resource identifier. Use the `MoveBillingAccount` method to update the account's parent resource if it is a organization. Format: - organizations/{organization_id}, for example: organizations/12345678 - billingAccounts/{billing_account_id}, for example: `billingAccounts/012345-567890-ABCDEF`
+ "parent": "A String", # Output only. The billing account's parent resource identifier. Use the `MoveBillingAccount` method to update the account's parent resource if it is a organization. Format: - `organizations/{organization_id}`, for example, `organizations/12345678` - `billingAccounts/{billing_account_id}`, for example, `billingAccounts/012345-567890-ABCDEF`
}
@@ -134,8 +134,8 @@ Method Details
Lists the billing accounts that the current authenticated user has permission to [view](https://cloud.google.com/billing/docs/how-to/billing-access).
Args:
- parent: string, Optional. The parent resource to list billing accounts from. Format: - organizations/{organization_id} eg organizations/12345678 - billingAccounts/{billing_account_id} eg `billingAccounts/012345-567890-ABCDEF` (required)
- filter: string, Options for how to filter the returned billing accounts. This only supports filtering for [subaccounts](https://cloud.google.com/billing/docs/concepts) under a single provided parent billing account. (e.g. "master_billing_account=billingAccounts/012345-678901-ABCDEF"). Boolean algebra and other fields are not currently supported.
+ parent: string, Optional. The parent resource to list billing accounts from. Format: - `organizations/{organization_id}`, for example, `organizations/12345678` - `billingAccounts/{billing_account_id}`, for example, `billingAccounts/012345-567890-ABCDEF` (required)
+ filter: string, Options for how to filter the returned billing accounts. This only supports filtering for [subaccounts](https://cloud.google.com/billing/docs/concepts) under a single provided parent billing account. (for example, `master_billing_account=billingAccounts/012345-678901-ABCDEF`). Boolean algebra and other fields are not currently supported.
pageSize: integer, Requested page size. The maximum page size is 100; this is also the default.
pageToken: string, A token identifying a page of results to return. This should be a `next_page_token` value returned from a previous `ListBillingAccounts` call. If unspecified, the first page of results is returned.
x__xgafv: string, V1 error format.
@@ -153,7 +153,7 @@ Method Details
"masterBillingAccount": "A String", # If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty.
"name": "A String", # Output only. The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`.
"open": True or False, # Output only. True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it will be unable to use paid services.
- "parent": "A String", # Output only. The billing account's parent resource identifier. Use the `MoveBillingAccount` method to update the account's parent resource if it is a organization. Format: - organizations/{organization_id}, for example: organizations/12345678 - billingAccounts/{billing_account_id}, for example: `billingAccounts/012345-567890-ABCDEF`
+ "parent": "A String", # Output only. The billing account's parent resource identifier. Use the `MoveBillingAccount` method to update the account's parent resource if it is a organization. Format: - `organizations/{organization_id}`, for example, `organizations/12345678` - `billingAccounts/{billing_account_id}`, for example, `billingAccounts/012345-567890-ABCDEF`
},
],
"nextPageToken": "A String", # A token to retrieve the next page of results. To retrieve the next page, call `ListBillingAccounts` again with the `page_token` field set to this value. This field is empty if there are no more results to retrieve.
@@ -194,7 +194,7 @@ Method Details
"masterBillingAccount": "A String", # If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty.
"name": "A String", # Output only. The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`.
"open": True or False, # Output only. True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it will be unable to use paid services.
- "parent": "A String", # Output only. The billing account's parent resource identifier. Use the `MoveBillingAccount` method to update the account's parent resource if it is a organization. Format: - organizations/{organization_id}, for example: organizations/12345678 - billingAccounts/{billing_account_id}, for example: `billingAccounts/012345-567890-ABCDEF`
+ "parent": "A String", # Output only. The billing account's parent resource identifier. Use the `MoveBillingAccount` method to update the account's parent resource if it is a organization. Format: - `organizations/{organization_id}`, for example, `organizations/12345678` - `billingAccounts/{billing_account_id}`, for example, `billingAccounts/012345-567890-ABCDEF`
}
diff --git a/docs/dyn/cloudbilling_v1beta.billingAccounts.html b/docs/dyn/cloudbilling_v1beta.billingAccounts.html
index 1433c971eb4..97ba9893545 100644
--- a/docs/dyn/cloudbilling_v1beta.billingAccounts.html
+++ b/docs/dyn/cloudbilling_v1beta.billingAccounts.html
@@ -133,9 +133,9 @@ Method Details
},
"workloads": [ # The Google Cloud usage whose costs are estimated. A maximum of 100 workloads can be provided.
{ # Specifies usage on a single Google Cloud product over a time frame. Each Google Cloud product has its own message, containing specific product configuration parameters of the product usage amounts along each dimension in which the product is billed.
- "cloudCdnEgressWorkload": { # Specifies usage for Cloud CDN egress. # Usage on Google Cloud CDN Egress.
- "cacheEgressDestination": "A String", # The destination for the cache egress charges.
- "cacheEgressRate": { # An amount of usage over a time frame. # Cache egress usage. The rate of data cache egressed in the destination. For example : units such as "GiBy/s" or "TBy/mo".
+ "cloudCdnEgressWorkload": { # Specifies usage for Cloud CDN Data Transfer. # Usage on Google Cloud CDN Data Transfer.
+ "cacheEgressDestination": "A String", # The destination for the cache data transfer.
+ "cacheEgressRate": { # An amount of usage over a time frame. # Cache data transfer usage. The rate of data cache transferred to the destination. Use units such as GiB/s or TiB/mo.
"usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
"unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
"usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
@@ -182,8 +182,8 @@ Method Details
},
},
},
- "cloudInterconnectEgressWorkload": { # The interconnect egress only includes the Interconnect Egress. Please use the standard egress traffic interface to specify your standard egress usage. # Usage on Google Cloud Interconnect Egress.
- "egressRate": { # An amount of usage over a time frame. # Data egress usage. This usage applies when you move or copy data from one Google Cloud service to another service. Expected units such as "GiBy/s, By/s, etc."
+ "cloudInterconnectEgressWorkload": { # Includes the estimate for Interconnect Data Transfer only. To specify usage for data transfer between VMs and internet end-points, use the Standard Tier Internet Data Transfer interface. # Usage on Google Cloud Interconnect Data Transfer.
+ "egressRate": { # An amount of usage over a time frame. # Outbound data transfer usage. This usage applies when you move or copy data from one Google Cloud service to another service. The units are "GiB/s, B/s, and so on."
"usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
"unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
"usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
@@ -196,7 +196,7 @@ Method Details
],
},
},
- "interconnectConnectionLocation": "A String", # Locations in the [Interconnect connection location table](https://cloud.google.com/vpc/network-pricing#interconnect-pricing). This is the interconnect egress charges.
+ "interconnectConnectionLocation": "A String", # Locations in the [Interconnect connection location table](https://cloud.google.com/vpc/network-pricing#interconnect-pricing). These are the Interconnect Data Transfer charges.
},
"cloudInterconnectWorkload": { # Specifies usage for Cloud Interconnect resources. # Usage on Google Cloud Interconnect.
"interconnectAttachments": [ # VLAN attachment used for interconnect.
@@ -233,9 +233,9 @@ Method Details
},
},
},
- "cloudStorageEgressWorkload": { # Specification of a network type. Network egress within Google Cloud applies when you move or copy data from one Cloud Storage bucket to another or when another Google Cloud service accesses data in your Cloud Storage bucket.This includes the network egress within Google Cloud and the general network usage. # Usage on a cloud storage egress.
+ "cloudStorageEgressWorkload": { # Specification of a network type. Network data transfer within Google Cloud applies when you move or copy data from one Cloud Storage bucket to another or when another Google Cloud service accesses data in your Cloud Storage bucket.This includes the network data transfer within Google Cloud and the general network usage. # Usage on Cloud Storage Data Transfer.
"destinationContinent": "A String", # Where the data is sent to.
- "egressRate": { # An amount of usage over a time frame. # Egress usage rate. This usage applies when you move or copy data from one Cloud Storage bucket to another or when another Google Cloud service accesses data in your Cloud Storage bucket. Expected units such as "GiBy/s, By/s, ..."
+ "egressRate": { # An amount of usage over a time frame. # Data transfer usage rate. This usage applies when you move or copy data from one Cloud Storage bucket to another or when another Google Cloud service accesses data in your Cloud Storage bucket. Expected units such as "GiB/s, B/s, ..."
"usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
"unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
"usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
@@ -382,9 +382,9 @@ Method Details
"region": "A String", # The [region](https://cloud.google.com/compute/docs/regions-zones) where the VMs run. For example: "us-central1".
},
"name": "A String", # Required. A name for this workload. All workloads in a `CostScenario` must have a unique `name`. Each `name` may be at most 128 characters long.
- "premiumTierEgressWorkload": { # Specify Premium Tier Internet egress networking. # Usage on Premium Tier Internet Egress.
+ "premiumTierEgressWorkload": { # Specify a Premium Tier Internet Data Transfer networking workload. # Usage on Premium Tier Internet Data Transfer.
"destinationContinent": "A String", # Where the data is sent to.
- "egressRate": { # An amount of usage over a time frame. # Premium Tier egress usage. Expected units such as "GiBy/s, By/s, etc."
+ "egressRate": { # An amount of usage over a time frame. # Premium Tier Data Transfer usage. The expected units are GiB/s, B/s, and so on.
"usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
"unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
"usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
@@ -397,10 +397,10 @@ Method Details
],
},
},
- "sourceRegion": "A String", # Which [region](https://cloud.google.com/compute/docs/regions-zones) the egress data comes from.
+ "sourceRegion": "A String", # Which [region](https://cloud.google.com/compute/docs/regions-zones) the data comes from.
},
- "standardTierEgressWorkload": { # Specify Standard Tier Internet egress networking. # Usage on Standard Tier Internet Egress.
- "egressRate": { # An amount of usage over a time frame. # Standard tier egress usage. Expected units such as "GiBy/s, By/s, etc."
+ "standardTierEgressWorkload": { # Specify Standard Tier Internet Data Transfer. # Usage on Standard Tier Internet Data Transfer.
+ "egressRate": { # An amount of usage over a time frame. # Standard Tier Data Transfer usage. The expected units are GiB/s, B/s, and so on.
"usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
"unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
"usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
@@ -413,12 +413,12 @@ Method Details
],
},
},
- "sourceRegion": "A String", # Which [region](https://cloud.google.com/compute/docs/regions-zones) the egress data comes from.
+ "sourceRegion": "A String", # Which [region](https://cloud.google.com/compute/docs/regions-zones) the data is transferred from.
},
- "vmToVmEgressWorkload": { # Specify VM to VM egress. # Usage on Vm to Vm Egress.
- "interRegionEgress": { # Egress traffic between two regions.
- "destinationRegion": "A String", # Which [region](https://cloud.google.com/compute/docs/regions-zones) the egress data goes to.
- "egressRate": { # An amount of usage over a time frame. # VM to VM egress usage. Expected units such as "GiBy/s, By/s, etc."
+ "vmToVmEgressWorkload": { # Specify VM to VM data transfer. # Usage on VM to VM Data Transfer.
+ "interRegionEgress": { # Data transfer between two regions.
+ "destinationRegion": "A String", # Which [region](https://cloud.google.com/compute/docs/regions-zones) the data is transferred to.
+ "egressRate": { # An amount of usage over a time frame. # VM to VM data transfer usage. The expected units such are GiB/s, B/s, and so on.
"usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
"unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
"usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
@@ -431,10 +431,10 @@ Method Details
],
},
},
- "sourceRegion": "A String", # Which [region](https://cloud.google.com/compute/docs/regions-zones) the egress data comes from.
+ "sourceRegion": "A String", # Which [region](https://cloud.google.com/compute/docs/regions-zones) the data is transferred from.
},
- "intraRegionEgress": { # Egress traffic within the same region. When source region and destination region are in the same zone, using the internal IP addresses, there isn't any egress charge.
- "egressRate": { # An amount of usage over a time frame. # VM to VM egress usage. Expected units such as "GiBy/s, By/s, etc."
+ "intraRegionEgress": { # Data transfer within the same region. When the source region and destination region are in the same zone, using internal IP addresses, there isn't any charge for data transfer.
+ "egressRate": { # An amount of usage over a time frame. # VM to VM data transfer usage. The expected are GiB/s, B/s, and so on.
"usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
"unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
"usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
diff --git a/docs/dyn/cloudbilling_v1beta.billingAccounts.skus.html b/docs/dyn/cloudbilling_v1beta.billingAccounts.skus.html
index b5b2bfb6cac..8b12fc31e95 100644
--- a/docs/dyn/cloudbilling_v1beta.billingAccounts.skus.html
+++ b/docs/dyn/cloudbilling_v1beta.billingAccounts.skus.html
@@ -79,6 +79,11 @@ Instance Methods
Returns the price Resource.
+
+ prices()
+
+Returns the prices Resource.
+
Close httplib2 connections.
diff --git a/docs/dyn/cloudbilling_v1beta.billingAccounts.skus.prices.html b/docs/dyn/cloudbilling_v1beta.billingAccounts.skus.prices.html
new file mode 100644
index 00000000000..846cb3231c3
--- /dev/null
+++ b/docs/dyn/cloudbilling_v1beta.billingAccounts.skus.prices.html
@@ -0,0 +1,197 @@
+
+
+
+Cloud Billing API . billingAccounts . skus . prices
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ list(parent, currencyCode=None, pageSize=None, pageToken=None, x__xgafv=None)
+Lists the latest prices for SKUs available to your Cloud Billing account.
+
+Retrieves the next page of results.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ list(parent, currencyCode=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists the latest prices for SKUs available to your Cloud Billing account.
+
+Args:
+ parent: string, Required. To list all Billing Account SKUs, use `-` as the SKU ID. Format: `billingAccounts/{billing_account}/skus/-` Note: Specifying an actual SKU resource id will return a collection of one Billing Account Price. (required)
+ currencyCode: string, Optional. ISO-4217 currency code for the price. If not specified, currency of billing account will be used.
+ pageSize: integer, Optional. Maximum number of billing account price to return. Results may return fewer than this value. Default value is 50 and maximum value is 5000.
+ pageToken: string, Optional. Page token received from a previous ListBillingAccountPrices call to retrieve the next page of results. If this field is empty, the first page is returned.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for ListBillingAccountPrices.
+ "billingAccountPrices": [ # The returned billing account prices.
+ { # Encapsulates the latest price for a billing account SKU.
+ "currencyCode": "A String", # ISO-4217 currency code for the price.
+ "name": "A String", # Resource name for the latest billing account price.
+ "priceReason": { # Encapsulates a price reason which contains background information about the origin of the price. # Background information on the origin of the price.
+ "defaultPrice": { # Encapsulates a default price which is the current list price. # Default price which is the current list price.
+ },
+ "fixedDiscount": { # Encapsulates a discount off the list price, anchored to the list price as of a fixed time. # Discount off the list price, anchored to the list price as of a fixed time.
+ "discountPercent": { # A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal. [BigDecimal]: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html [decimal.Decimal]: https://docs.python.org/3/library/decimal.html # Percentage of the fixed discount.
+ "value": "A String", # The decimal value, as a string. The string representation consists of an optional sign, `+` (`U+002B`) or `-` (`U+002D`), followed by a sequence of zero or more decimal digits ("the integer"), optionally followed by a fraction, optionally followed by an exponent. An empty string **should** be interpreted as `0`. The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. The number formed by the sign, the integer and the fraction is referred to as the significand. The exponent consists of the character `e` (`U+0065`) or `E` (`U+0045`) followed by one or more decimal digits. Services **should** normalize decimal values before storing them by: - Removing an explicitly-provided `+` sign (`+2.5` -> `2.5`). - Replacing a zero-length integer value with `0` (`.5` -> `0.5`). - Coercing the exponent character to upper-case, with explicit sign (`2.5e8` -> `2.5E+8`). - Removing an explicitly-provided zero exponent (`2.5E0` -> `2.5`). Services **may** perform additional normalization based on its own needs and the internal decimal implementation selected, such as shifting the decimal point and exponent value together (example: `2.5E-1` <-> `0.25`). Additionally, services **may** preserve trailing zeroes in the fraction to indicate increased precision, but are not required to do so. Note that only the `.` character is supported to divide the integer and the fraction; `,` **should not** be supported regardless of locale. Additionally, thousand separators **should not** be supported. If a service does support them, values **must** be normalized. The ENBF grammar is: DecimalString = '' | [Sign] Significand [Exponent]; Sign = '+' | '-'; Significand = Digits '.' | [Digits] '.' Digits; Exponent = ('e' | 'E') [Sign] Digits; Digits = { '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' }; Services **should** clearly document the range of supported values, the maximum supported precision (total number of digits), and, if applicable, the scale (number of digits after the decimal point), as well as how it behaves when receiving out-of-bounds values. Services **may** choose to accept values passed as input even when the value has a higher precision or scale than the service supports, and **should** round the value to fit the supported scale. Alternatively, the service **may** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if precision would be lost. Services **should** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if the service receives a value outside of the supported range.
+ },
+ "discountScopeType": "A String", # Type of the fixed discount scope which indicates the source of the discount. It can have values such as 'unspecified' and 'sku-group'.
+ "fixTime": "A String", # Time that the fixed discount is anchored to.
+ "skuGroup": "A String", # SKU group where the fixed discount comes from.
+ },
+ "fixedPrice": { # Encapsulates a set fixed price applicable during the terms of a contract agreement. # Fixed price applicable during the terms of a contract agreement.
+ },
+ "floatingDiscount": { # Encapsulates a discount off the current list price, not anchored to any list price as of a fixed time. # Discount off the current list price, not anchored to any list price as of a fixed time.
+ "discountPercent": { # A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal. [BigDecimal]: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html [decimal.Decimal]: https://docs.python.org/3/library/decimal.html # Percentage of the floating discount.
+ "value": "A String", # The decimal value, as a string. The string representation consists of an optional sign, `+` (`U+002B`) or `-` (`U+002D`), followed by a sequence of zero or more decimal digits ("the integer"), optionally followed by a fraction, optionally followed by an exponent. An empty string **should** be interpreted as `0`. The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. The number formed by the sign, the integer and the fraction is referred to as the significand. The exponent consists of the character `e` (`U+0065`) or `E` (`U+0045`) followed by one or more decimal digits. Services **should** normalize decimal values before storing them by: - Removing an explicitly-provided `+` sign (`+2.5` -> `2.5`). - Replacing a zero-length integer value with `0` (`.5` -> `0.5`). - Coercing the exponent character to upper-case, with explicit sign (`2.5e8` -> `2.5E+8`). - Removing an explicitly-provided zero exponent (`2.5E0` -> `2.5`). Services **may** perform additional normalization based on its own needs and the internal decimal implementation selected, such as shifting the decimal point and exponent value together (example: `2.5E-1` <-> `0.25`). Additionally, services **may** preserve trailing zeroes in the fraction to indicate increased precision, but are not required to do so. Note that only the `.` character is supported to divide the integer and the fraction; `,` **should not** be supported regardless of locale. Additionally, thousand separators **should not** be supported. If a service does support them, values **must** be normalized. The ENBF grammar is: DecimalString = '' | [Sign] Significand [Exponent]; Sign = '+' | '-'; Significand = Digits '.' | [Digits] '.' Digits; Exponent = ('e' | 'E') [Sign] Digits; Digits = { '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' }; Services **should** clearly document the range of supported values, the maximum supported precision (total number of digits), and, if applicable, the scale (number of digits after the decimal point), as well as how it behaves when receiving out-of-bounds values. Services **may** choose to accept values passed as input even when the value has a higher precision or scale than the service supports, and **should** round the value to fit the supported scale. Alternatively, the service **may** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if precision would be lost. Services **should** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if the service receives a value outside of the supported range.
+ },
+ "discountScopeType": "A String", # Type of the floating discount scope which indicates the source of the discount. It can have values such as 'unspecified' and 'sku-group'.
+ "skuGroup": "A String", # SKU group where the floating discount comes from.
+ },
+ "listPriceAsCeiling": { # Encapsulates a contract feature that the list price (DefaultPrice) will be used for the price if the current list price drops lower than the custom fixed price. Available to new contracts after March 21, 2022. Applies to all fixed price SKUs in the contract, including FixedPrice, FixedDiscount, MigratedPrice, and MergedPrice. # Contract feature that the list price (DefaultPrice) will be used for the price if the current list price drops lower than the custom fixed price. Available to new contracts after March 21, 2022. Applies to all fixed price SKUs in the contract, including FixedPrice, FixedDiscount, MigratedPrice, and MergedPrice.
+ },
+ "mergedPrice": { # Encapsulates a price after merging from multiple sources. With merged tiers, each individual tier can be from a different source with different discount types. # Price after merging from multiple sources.
+ },
+ "migratedPrice": { # Encapsulates a price migrated from other SKUs. # Price migrated from other SKUs.
+ "sourceSku": "A String", # Source SKU where the discount is migrated from. Format: billingAccounts/{billing_account}/skus/{sku}
+ },
+ "type": "A String", # Type of the price reason. It can have values such as 'unspecified', 'default-price', 'fixed-price', 'fixed-discount', 'floating-discount', 'migrated-price', 'merged-price', 'list-price-as-ceiling'.
+ },
+ "rate": { # Encapsulates a `Rate` price. Billing account SKUs with `Rate` price are offered by pricing tiers. The price have 1 or more rate pricing tiers. # Rate price metadata. Billing account SKUs with `Rate` price are offered by pricing tiers. The price can have 1 or more rate pricing tiers.
+ "aggregationInfo": { # Encapsulates the aggregation information such as aggregation level and interval for a billing account price. # Aggregation info for tiers such as aggregation level and interval.
+ "interval": "A String", # Interval at which usage is aggregated to compute cost. Example: "MONTHLY" interval indicates that usage is aggregated every month.
+ "level": "A String", # Level at which usage is aggregated to compute cost. Example: "ACCOUNT" level indicates that usage is aggregated across all projects in a single account.
+ },
+ "tiers": [ # All tiers associated with the `Rate` price.
+ { # Encapsulates a rate price tier.
+ "contractPrice": { # Represents an amount of money with its currency type. # Negotiated contract price specific for a billing account.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "effectiveDiscountPercent": { # A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal. [BigDecimal]: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html [decimal.Decimal]: https://docs.python.org/3/library/decimal.html # Percentage of effective discount calculated using the current list price per pricing tier. Formula used: effective_discount_percent = (list_price - contract_price) / list_price × 100 If list_price and contract_price are zero, this field is the same as `discount_percent` of FixedDiscount and FloatingDiscount. If your contract does NOT have the feature LIST_PRICE_AS_CEILING enabled, the effective_discount_percent can be negative if the SKU has a FixedDiscount and the current list price is lower than the list price on the date of the contract agreement. See the `FixedDiscount.fix_time` on when the discount was set. If you have questions regarding pricing per SKU, contact your Account team for more details.
+ "value": "A String", # The decimal value, as a string. The string representation consists of an optional sign, `+` (`U+002B`) or `-` (`U+002D`), followed by a sequence of zero or more decimal digits ("the integer"), optionally followed by a fraction, optionally followed by an exponent. An empty string **should** be interpreted as `0`. The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. The number formed by the sign, the integer and the fraction is referred to as the significand. The exponent consists of the character `e` (`U+0065`) or `E` (`U+0045`) followed by one or more decimal digits. Services **should** normalize decimal values before storing them by: - Removing an explicitly-provided `+` sign (`+2.5` -> `2.5`). - Replacing a zero-length integer value with `0` (`.5` -> `0.5`). - Coercing the exponent character to upper-case, with explicit sign (`2.5e8` -> `2.5E+8`). - Removing an explicitly-provided zero exponent (`2.5E0` -> `2.5`). Services **may** perform additional normalization based on its own needs and the internal decimal implementation selected, such as shifting the decimal point and exponent value together (example: `2.5E-1` <-> `0.25`). Additionally, services **may** preserve trailing zeroes in the fraction to indicate increased precision, but are not required to do so. Note that only the `.` character is supported to divide the integer and the fraction; `,` **should not** be supported regardless of locale. Additionally, thousand separators **should not** be supported. If a service does support them, values **must** be normalized. The ENBF grammar is: DecimalString = '' | [Sign] Significand [Exponent]; Sign = '+' | '-'; Significand = Digits '.' | [Digits] '.' Digits; Exponent = ('e' | 'E') [Sign] Digits; Digits = { '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' }; Services **should** clearly document the range of supported values, the maximum supported precision (total number of digits), and, if applicable, the scale (number of digits after the decimal point), as well as how it behaves when receiving out-of-bounds values. Services **may** choose to accept values passed as input even when the value has a higher precision or scale than the service supports, and **should** round the value to fit the supported scale. Alternatively, the service **may** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if precision would be lost. Services **should** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if the service receives a value outside of the supported range.
+ },
+ "listPrice": { # Represents an amount of money with its currency type. # List price of one tier.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "startAmount": { # A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal. [BigDecimal]: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html [decimal.Decimal]: https://docs.python.org/3/library/decimal.html # Lower bound amount for a tier. Tiers 0-100, 100-200 will be represented with two tiers with `start_amount` 0 and 100.
+ "value": "A String", # The decimal value, as a string. The string representation consists of an optional sign, `+` (`U+002B`) or `-` (`U+002D`), followed by a sequence of zero or more decimal digits ("the integer"), optionally followed by a fraction, optionally followed by an exponent. An empty string **should** be interpreted as `0`. The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. The number formed by the sign, the integer and the fraction is referred to as the significand. The exponent consists of the character `e` (`U+0065`) or `E` (`U+0045`) followed by one or more decimal digits. Services **should** normalize decimal values before storing them by: - Removing an explicitly-provided `+` sign (`+2.5` -> `2.5`). - Replacing a zero-length integer value with `0` (`.5` -> `0.5`). - Coercing the exponent character to upper-case, with explicit sign (`2.5e8` -> `2.5E+8`). - Removing an explicitly-provided zero exponent (`2.5E0` -> `2.5`). Services **may** perform additional normalization based on its own needs and the internal decimal implementation selected, such as shifting the decimal point and exponent value together (example: `2.5E-1` <-> `0.25`). Additionally, services **may** preserve trailing zeroes in the fraction to indicate increased precision, but are not required to do so. Note that only the `.` character is supported to divide the integer and the fraction; `,` **should not** be supported regardless of locale. Additionally, thousand separators **should not** be supported. If a service does support them, values **must** be normalized. The ENBF grammar is: DecimalString = '' | [Sign] Significand [Exponent]; Sign = '+' | '-'; Significand = Digits '.' | [Digits] '.' Digits; Exponent = ('e' | 'E') [Sign] Digits; Digits = { '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' }; Services **should** clearly document the range of supported values, the maximum supported precision (total number of digits), and, if applicable, the scale (number of digits after the decimal point), as well as how it behaves when receiving out-of-bounds values. Services **may** choose to accept values passed as input even when the value has a higher precision or scale than the service supports, and **should** round the value to fit the supported scale. Alternatively, the service **may** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if precision would be lost. Services **should** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if the service receives a value outside of the supported range.
+ },
+ },
+ ],
+ "unitInfo": { # Encapsulates the unit information for a Rate # Unit info such as name and quantity.
+ "unit": "A String", # Shorthand for the unit. Example: GiBy.mo.
+ "unitDescription": "A String", # Human-readable description of the unit. Example: gibibyte month.
+ "unitQuantity": { # A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal. [BigDecimal]: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html [decimal.Decimal]: https://docs.python.org/3/library/decimal.html # Unit quantity for the tier. Example: if the RateTier price is $1 per 1000000 Bytes, then `unit_quantity` is set to 1000000.
+ "value": "A String", # The decimal value, as a string. The string representation consists of an optional sign, `+` (`U+002B`) or `-` (`U+002D`), followed by a sequence of zero or more decimal digits ("the integer"), optionally followed by a fraction, optionally followed by an exponent. An empty string **should** be interpreted as `0`. The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. The number formed by the sign, the integer and the fraction is referred to as the significand. The exponent consists of the character `e` (`U+0065`) or `E` (`U+0045`) followed by one or more decimal digits. Services **should** normalize decimal values before storing them by: - Removing an explicitly-provided `+` sign (`+2.5` -> `2.5`). - Replacing a zero-length integer value with `0` (`.5` -> `0.5`). - Coercing the exponent character to upper-case, with explicit sign (`2.5e8` -> `2.5E+8`). - Removing an explicitly-provided zero exponent (`2.5E0` -> `2.5`). Services **may** perform additional normalization based on its own needs and the internal decimal implementation selected, such as shifting the decimal point and exponent value together (example: `2.5E-1` <-> `0.25`). Additionally, services **may** preserve trailing zeroes in the fraction to indicate increased precision, but are not required to do so. Note that only the `.` character is supported to divide the integer and the fraction; `,` **should not** be supported regardless of locale. Additionally, thousand separators **should not** be supported. If a service does support them, values **must** be normalized. The ENBF grammar is: DecimalString = '' | [Sign] Significand [Exponent]; Sign = '+' | '-'; Significand = Digits '.' | [Digits] '.' Digits; Exponent = ('e' | 'E') [Sign] Digits; Digits = { '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' }; Services **should** clearly document the range of supported values, the maximum supported precision (total number of digits), and, if applicable, the scale (number of digits after the decimal point), as well as how it behaves when receiving out-of-bounds values. Services **may** choose to accept values passed as input even when the value has a higher precision or scale than the service supports, and **should** round the value to fit the supported scale. Alternatively, the service **may** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if precision would be lost. Services **should** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if the service receives a value outside of the supported range.
+ },
+ },
+ },
+ "valueType": "A String", # Type of the price. The possible values are: ["unspecified", "rate"].
+ },
+ ],
+ "nextPageToken": "A String", # Token that can be sent as `page_token` in the subsequent request to retrieve the next page. If this field is empty, there are no subsequent pages.
+}
+
+
+
+ list_next()
+ Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/cloudbilling_v1beta.skus.html b/docs/dyn/cloudbilling_v1beta.skus.html
index a2058172320..2fb2b244a04 100644
--- a/docs/dyn/cloudbilling_v1beta.skus.html
+++ b/docs/dyn/cloudbilling_v1beta.skus.html
@@ -79,6 +79,11 @@ Instance Methods
Returns the price Resource.
+
+ prices()
+
+Returns the prices Resource.
+
Close httplib2 connections.
diff --git a/docs/dyn/cloudbilling_v1beta.skus.prices.html b/docs/dyn/cloudbilling_v1beta.skus.prices.html
new file mode 100644
index 00000000000..af9d11726da
--- /dev/null
+++ b/docs/dyn/cloudbilling_v1beta.skus.prices.html
@@ -0,0 +1,160 @@
+
+
+
+Cloud Billing API . skus . prices
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ list(parent, currencyCode=None, pageSize=None, pageToken=None, x__xgafv=None)
+Lists the latest prices for all SKUs.
+
+Retrieves the next page of results.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ list(parent, currencyCode=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists the latest prices for all SKUs.
+
+Args:
+ parent: string, Required. To list the prices for all SKUs, use `-` as the SKU ID. Format: `skus/-` Specifying a specific SKU ID returns a collection with one Price object for the SKU. (required)
+ currencyCode: string, Optional. ISO-4217 currency code for the price. If not specified, USD will be used.
+ pageSize: integer, Optional. Maximum number of prices to return. Results may return fewer than this value. Default value is 50 and maximum value is 5000.
+ pageToken: string, Optional. Page token received from a previous ListPrices call to retrieve the next page of results. If this field is empty, the first page is returned.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for ListPrices.
+ "nextPageToken": "A String", # Token that can be sent as `page_token` in the subsequent request to retrieve the next page. If this field is empty, there are no subsequent pages.
+ "prices": [ # The returned publicly listed prices.
+ { # Encapsulates the latest price for a SKU.
+ "currencyCode": "A String", # ISO-4217 currency code for the price.
+ "name": "A String", # Resource name for the latest price.
+ "rate": { # Encapsulates a `Rate` price. SKUs with `Rate` price are offered by pricing tiers. The price have 1 or more rate pricing tiers. # Rate price metadata. SKUs with `Rate` price are offered by pricing tiers. The price can have 1 or more rate pricing tiers.
+ "aggregationInfo": { # Encapsulates the aggregation information such as aggregation level and interval for a price. # Aggregation info for tiers such as aggregation level and interval.
+ "interval": "A String", # Interval at which usage is aggregated to compute cost. Example: "MONTHLY" interval indicates that usage is aggregated every month.
+ "level": "A String", # Level at which usage is aggregated to compute cost. Example: "ACCOUNT" level indicates that usage is aggregated across all projects in a single account.
+ },
+ "tiers": [ # All tiers associated with the `Rate` price.
+ { # Encapsulates a rate price tier.
+ "listPrice": { # Represents an amount of money with its currency type. # List price of one tier.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "startAmount": { # A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal. [BigDecimal]: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html [decimal.Decimal]: https://docs.python.org/3/library/decimal.html # Lower bound amount for a tier. Tiers 0-100, 100-200 will be represented with two tiers with `start_amount` 0 and 100.
+ "value": "A String", # The decimal value, as a string. The string representation consists of an optional sign, `+` (`U+002B`) or `-` (`U+002D`), followed by a sequence of zero or more decimal digits ("the integer"), optionally followed by a fraction, optionally followed by an exponent. An empty string **should** be interpreted as `0`. The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. The number formed by the sign, the integer and the fraction is referred to as the significand. The exponent consists of the character `e` (`U+0065`) or `E` (`U+0045`) followed by one or more decimal digits. Services **should** normalize decimal values before storing them by: - Removing an explicitly-provided `+` sign (`+2.5` -> `2.5`). - Replacing a zero-length integer value with `0` (`.5` -> `0.5`). - Coercing the exponent character to upper-case, with explicit sign (`2.5e8` -> `2.5E+8`). - Removing an explicitly-provided zero exponent (`2.5E0` -> `2.5`). Services **may** perform additional normalization based on its own needs and the internal decimal implementation selected, such as shifting the decimal point and exponent value together (example: `2.5E-1` <-> `0.25`). Additionally, services **may** preserve trailing zeroes in the fraction to indicate increased precision, but are not required to do so. Note that only the `.` character is supported to divide the integer and the fraction; `,` **should not** be supported regardless of locale. Additionally, thousand separators **should not** be supported. If a service does support them, values **must** be normalized. The ENBF grammar is: DecimalString = '' | [Sign] Significand [Exponent]; Sign = '+' | '-'; Significand = Digits '.' | [Digits] '.' Digits; Exponent = ('e' | 'E') [Sign] Digits; Digits = { '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' }; Services **should** clearly document the range of supported values, the maximum supported precision (total number of digits), and, if applicable, the scale (number of digits after the decimal point), as well as how it behaves when receiving out-of-bounds values. Services **may** choose to accept values passed as input even when the value has a higher precision or scale than the service supports, and **should** round the value to fit the supported scale. Alternatively, the service **may** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if precision would be lost. Services **should** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if the service receives a value outside of the supported range.
+ },
+ },
+ ],
+ "unitInfo": { # Encapsulates the unit information for a Rate # Unit info such as name and quantity.
+ "unit": "A String", # Shorthand for the unit. Example: GiBy.mo.
+ "unitDescription": "A String", # Human-readable description of the unit. Example: gibibyte month.
+ "unitQuantity": { # A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal. [BigDecimal]: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html [decimal.Decimal]: https://docs.python.org/3/library/decimal.html # Unit quantity for the tier. Example: if the RateTier price is $1 per 1000000 Bytes, then `unit_quantity` is set to 1000000.
+ "value": "A String", # The decimal value, as a string. The string representation consists of an optional sign, `+` (`U+002B`) or `-` (`U+002D`), followed by a sequence of zero or more decimal digits ("the integer"), optionally followed by a fraction, optionally followed by an exponent. An empty string **should** be interpreted as `0`. The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. The number formed by the sign, the integer and the fraction is referred to as the significand. The exponent consists of the character `e` (`U+0065`) or `E` (`U+0045`) followed by one or more decimal digits. Services **should** normalize decimal values before storing them by: - Removing an explicitly-provided `+` sign (`+2.5` -> `2.5`). - Replacing a zero-length integer value with `0` (`.5` -> `0.5`). - Coercing the exponent character to upper-case, with explicit sign (`2.5e8` -> `2.5E+8`). - Removing an explicitly-provided zero exponent (`2.5E0` -> `2.5`). Services **may** perform additional normalization based on its own needs and the internal decimal implementation selected, such as shifting the decimal point and exponent value together (example: `2.5E-1` <-> `0.25`). Additionally, services **may** preserve trailing zeroes in the fraction to indicate increased precision, but are not required to do so. Note that only the `.` character is supported to divide the integer and the fraction; `,` **should not** be supported regardless of locale. Additionally, thousand separators **should not** be supported. If a service does support them, values **must** be normalized. The ENBF grammar is: DecimalString = '' | [Sign] Significand [Exponent]; Sign = '+' | '-'; Significand = Digits '.' | [Digits] '.' Digits; Exponent = ('e' | 'E') [Sign] Digits; Digits = { '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' }; Services **should** clearly document the range of supported values, the maximum supported precision (total number of digits), and, if applicable, the scale (number of digits after the decimal point), as well as how it behaves when receiving out-of-bounds values. Services **may** choose to accept values passed as input even when the value has a higher precision or scale than the service supports, and **should** round the value to fit the supported scale. Alternatively, the service **may** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if precision would be lost. Services **should** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if the service receives a value outside of the supported range.
+ },
+ },
+ },
+ "valueType": "A String", # Type of the price. It can have values: ["unspecified", "rate"].
+ },
+ ],
+}
+
+
+
+ list_next()
+ Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/cloudbilling_v1beta.v1beta.html b/docs/dyn/cloudbilling_v1beta.v1beta.html
index fc77fbc50fa..e1d4b0253da 100644
--- a/docs/dyn/cloudbilling_v1beta.v1beta.html
+++ b/docs/dyn/cloudbilling_v1beta.v1beta.html
@@ -117,9 +117,9 @@ Method Details
},
"workloads": [ # The Google Cloud usage whose costs are estimated. A maximum of 100 workloads can be provided.
{ # Specifies usage on a single Google Cloud product over a time frame. Each Google Cloud product has its own message, containing specific product configuration parameters of the product usage amounts along each dimension in which the product is billed.
- "cloudCdnEgressWorkload": { # Specifies usage for Cloud CDN egress. # Usage on Google Cloud CDN Egress.
- "cacheEgressDestination": "A String", # The destination for the cache egress charges.
- "cacheEgressRate": { # An amount of usage over a time frame. # Cache egress usage. The rate of data cache egressed in the destination. For example : units such as "GiBy/s" or "TBy/mo".
+ "cloudCdnEgressWorkload": { # Specifies usage for Cloud CDN Data Transfer. # Usage on Google Cloud CDN Data Transfer.
+ "cacheEgressDestination": "A String", # The destination for the cache data transfer.
+ "cacheEgressRate": { # An amount of usage over a time frame. # Cache data transfer usage. The rate of data cache transferred to the destination. Use units such as GiB/s or TiB/mo.
"usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
"unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
"usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
@@ -166,8 +166,8 @@ Method Details
},
},
},
- "cloudInterconnectEgressWorkload": { # The interconnect egress only includes the Interconnect Egress. Please use the standard egress traffic interface to specify your standard egress usage. # Usage on Google Cloud Interconnect Egress.
- "egressRate": { # An amount of usage over a time frame. # Data egress usage. This usage applies when you move or copy data from one Google Cloud service to another service. Expected units such as "GiBy/s, By/s, etc."
+ "cloudInterconnectEgressWorkload": { # Includes the estimate for Interconnect Data Transfer only. To specify usage for data transfer between VMs and internet end-points, use the Standard Tier Internet Data Transfer interface. # Usage on Google Cloud Interconnect Data Transfer.
+ "egressRate": { # An amount of usage over a time frame. # Outbound data transfer usage. This usage applies when you move or copy data from one Google Cloud service to another service. The units are "GiB/s, B/s, and so on."
"usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
"unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
"usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
@@ -180,7 +180,7 @@ Method Details
],
},
},
- "interconnectConnectionLocation": "A String", # Locations in the [Interconnect connection location table](https://cloud.google.com/vpc/network-pricing#interconnect-pricing). This is the interconnect egress charges.
+ "interconnectConnectionLocation": "A String", # Locations in the [Interconnect connection location table](https://cloud.google.com/vpc/network-pricing#interconnect-pricing). These are the Interconnect Data Transfer charges.
},
"cloudInterconnectWorkload": { # Specifies usage for Cloud Interconnect resources. # Usage on Google Cloud Interconnect.
"interconnectAttachments": [ # VLAN attachment used for interconnect.
@@ -217,9 +217,9 @@ Method Details
},
},
},
- "cloudStorageEgressWorkload": { # Specification of a network type. Network egress within Google Cloud applies when you move or copy data from one Cloud Storage bucket to another or when another Google Cloud service accesses data in your Cloud Storage bucket.This includes the network egress within Google Cloud and the general network usage. # Usage on a cloud storage egress.
+ "cloudStorageEgressWorkload": { # Specification of a network type. Network data transfer within Google Cloud applies when you move or copy data from one Cloud Storage bucket to another or when another Google Cloud service accesses data in your Cloud Storage bucket.This includes the network data transfer within Google Cloud and the general network usage. # Usage on Cloud Storage Data Transfer.
"destinationContinent": "A String", # Where the data is sent to.
- "egressRate": { # An amount of usage over a time frame. # Egress usage rate. This usage applies when you move or copy data from one Cloud Storage bucket to another or when another Google Cloud service accesses data in your Cloud Storage bucket. Expected units such as "GiBy/s, By/s, ..."
+ "egressRate": { # An amount of usage over a time frame. # Data transfer usage rate. This usage applies when you move or copy data from one Cloud Storage bucket to another or when another Google Cloud service accesses data in your Cloud Storage bucket. Expected units such as "GiB/s, B/s, ..."
"usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
"unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
"usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
@@ -366,9 +366,9 @@ Method Details
"region": "A String", # The [region](https://cloud.google.com/compute/docs/regions-zones) where the VMs run. For example: "us-central1".
},
"name": "A String", # Required. A name for this workload. All workloads in a `CostScenario` must have a unique `name`. Each `name` may be at most 128 characters long.
- "premiumTierEgressWorkload": { # Specify Premium Tier Internet egress networking. # Usage on Premium Tier Internet Egress.
+ "premiumTierEgressWorkload": { # Specify a Premium Tier Internet Data Transfer networking workload. # Usage on Premium Tier Internet Data Transfer.
"destinationContinent": "A String", # Where the data is sent to.
- "egressRate": { # An amount of usage over a time frame. # Premium Tier egress usage. Expected units such as "GiBy/s, By/s, etc."
+ "egressRate": { # An amount of usage over a time frame. # Premium Tier Data Transfer usage. The expected units are GiB/s, B/s, and so on.
"usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
"unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
"usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
@@ -381,10 +381,10 @@ Method Details
],
},
},
- "sourceRegion": "A String", # Which [region](https://cloud.google.com/compute/docs/regions-zones) the egress data comes from.
+ "sourceRegion": "A String", # Which [region](https://cloud.google.com/compute/docs/regions-zones) the data comes from.
},
- "standardTierEgressWorkload": { # Specify Standard Tier Internet egress networking. # Usage on Standard Tier Internet Egress.
- "egressRate": { # An amount of usage over a time frame. # Standard tier egress usage. Expected units such as "GiBy/s, By/s, etc."
+ "standardTierEgressWorkload": { # Specify Standard Tier Internet Data Transfer. # Usage on Standard Tier Internet Data Transfer.
+ "egressRate": { # An amount of usage over a time frame. # Standard Tier Data Transfer usage. The expected units are GiB/s, B/s, and so on.
"usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
"unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
"usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
@@ -397,12 +397,12 @@ Method Details
],
},
},
- "sourceRegion": "A String", # Which [region](https://cloud.google.com/compute/docs/regions-zones) the egress data comes from.
+ "sourceRegion": "A String", # Which [region](https://cloud.google.com/compute/docs/regions-zones) the data is transferred from.
},
- "vmToVmEgressWorkload": { # Specify VM to VM egress. # Usage on Vm to Vm Egress.
- "interRegionEgress": { # Egress traffic between two regions.
- "destinationRegion": "A String", # Which [region](https://cloud.google.com/compute/docs/regions-zones) the egress data goes to.
- "egressRate": { # An amount of usage over a time frame. # VM to VM egress usage. Expected units such as "GiBy/s, By/s, etc."
+ "vmToVmEgressWorkload": { # Specify VM to VM data transfer. # Usage on VM to VM Data Transfer.
+ "interRegionEgress": { # Data transfer between two regions.
+ "destinationRegion": "A String", # Which [region](https://cloud.google.com/compute/docs/regions-zones) the data is transferred to.
+ "egressRate": { # An amount of usage over a time frame. # VM to VM data transfer usage. The expected units such are GiB/s, B/s, and so on.
"usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
"unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
"usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
@@ -415,10 +415,10 @@ Method Details
],
},
},
- "sourceRegion": "A String", # Which [region](https://cloud.google.com/compute/docs/regions-zones) the egress data comes from.
+ "sourceRegion": "A String", # Which [region](https://cloud.google.com/compute/docs/regions-zones) the data is transferred from.
},
- "intraRegionEgress": { # Egress traffic within the same region. When source region and destination region are in the same zone, using the internal IP addresses, there isn't any egress charge.
- "egressRate": { # An amount of usage over a time frame. # VM to VM egress usage. Expected units such as "GiBy/s, By/s, etc."
+ "intraRegionEgress": { # Data transfer within the same region. When the source region and destination region are in the same zone, using internal IP addresses, there isn't any charge for data transfer.
+ "egressRate": { # An amount of usage over a time frame. # VM to VM data transfer usage. The expected are GiB/s, B/s, and so on.
"usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
"unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
"usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
diff --git a/docs/dyn/clouddeploy_v1.projects.locations.customTargetTypes.html b/docs/dyn/clouddeploy_v1.projects.locations.customTargetTypes.html
new file mode 100644
index 00000000000..e7ad1fa2596
--- /dev/null
+++ b/docs/dyn/clouddeploy_v1.projects.locations.customTargetTypes.html
@@ -0,0 +1,426 @@
+
+
+
+Cloud Deploy API . projects . locations . customTargetTypes
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ create(parent, body=None, customTargetTypeId=None, requestId=None, validateOnly=None, x__xgafv=None)
+Creates a new CustomTargetType in a given project and location.
+
+ delete(name, allowMissing=None, etag=None, requestId=None, validateOnly=None, x__xgafv=None)
+Deletes a single CustomTargetType.
+
+Gets details of a single CustomTargetType.
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+Lists CustomTargetTypes in a given project and location.
+
+Retrieves the next page of results.
+
+Updates a single CustomTargetType.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ create(parent, body=None, customTargetTypeId=None, requestId=None, validateOnly=None, x__xgafv=None)
+ Creates a new CustomTargetType in a given project and location.
+
+Args:
+ parent: string, Required. The parent collection in which the `CustomTargetType` should be created in. Format should be `projects/{project_id}/locations/{location_name}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A `CustomTargetType` resource in the Cloud Deploy API. A `CustomTargetType` defines a type of custom target that can be referenced in a `Target` in order to facilitate deploying to a runtime that does not have a 1P integration with Cloud Deploy.
+ "annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
+ "a_key": "A String",
+ },
+ "createTime": "A String", # Output only. Time at which the `CustomTargetType` was created.
+ "customActions": { # CustomTargetSkaffoldActions represents the `CustomTargetType` configuration using Skaffold custom actions. # Configures render and deploy for the `CustomTargetType` using Skaffold custom actions.
+ "deployAction": "A String", # Required. The Skaffold custom action responsible for deploy operations.
+ "includeSkaffoldModules": [ # Optional. List of Skaffold modules Cloud Deploy will include in the Skaffold Config as required before performing diagnose.
+ { # Skaffold Config modules and their remote source.
+ "configs": [ # Optional. The Skaffold Config modules to use from the specified source.
+ "A String",
+ ],
+ "git": { # Git repository containing Skaffold Config modules. # Remote git repository containing the Skaffold Config modules.
+ "path": "A String", # Optional. Relative path from the repository root to the Skaffold file.
+ "ref": "A String", # Optional. Git ref the package should be cloned from.
+ "repo": "A String", # Required. Git repository the package should be cloned from.
+ },
+ "googleCloudStorage": { # Cloud Storage bucket containing Skaffold Config modules. # Cloud Storage bucket containing the Skaffold Config modules.
+ "path": "A String", # Optional. Relative path from the source to the Skaffold file.
+ "source": "A String", # Required. Cloud Storage source paths to copy recursively. For example, providing "gs://my-bucket/dir/configs/*" will result in Skaffold copying all files within the "dir/configs" directory in the bucket "my-bucket".
+ },
+ },
+ ],
+ "renderAction": "A String", # Optional. The Skaffold custom action responsible for render operations. If not provided then Cloud Deploy will perform the render operations via `skaffold render`.
+ },
+ "customTargetTypeId": "A String", # Output only. Resource id of the `CustomTargetType`.
+ "description": "A String", # Optional. Description of the `CustomTargetType`. Max length is 255 characters.
+ "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
+ "a_key": "A String",
+ },
+ "name": "A String", # Optional. Name of the `CustomTargetType`. Format is `projects/{project}/locations/{location}/customTargetTypes/a-z{0,62}`.
+ "uid": "A String", # Output only. Unique identifier of the `CustomTargetType`.
+ "updateTime": "A String", # Output only. Most recent time at which the `CustomTargetType` was updated.
+}
+
+ customTargetTypeId: string, Required. ID of the `CustomTargetType`.
+ requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+ validateOnly: boolean, Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # 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). # The error result of the operation in case of failure or cancellation.
+ "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.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+
+
+
+ delete(name, allowMissing=None, etag=None, requestId=None, validateOnly=None, x__xgafv=None)
+ Deletes a single CustomTargetType.
+
+Args:
+ name: string, Required. The name of the `CustomTargetType` to delete. Format must be `projects/{project_id}/locations/{location_name}/customTargetTypes/{custom_target_type}`. (required)
+ allowMissing: boolean, Optional. If set to true, then deleting an already deleted or non-existing `CustomTargetType` will succeed.
+ etag: string, Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+ validateOnly: boolean, Optional. If set to true, the request is validated but no actual change is made.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # 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). # The error result of the operation in case of failure or cancellation.
+ "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.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+
+
+
+ get(name, x__xgafv=None)
+ Gets details of a single CustomTargetType.
+
+Args:
+ name: string, Required. Name of the `CustomTargetType`. Format must be `projects/{project_id}/locations/{location_name}/customTargetTypes/{custom_target_type}`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A `CustomTargetType` resource in the Cloud Deploy API. A `CustomTargetType` defines a type of custom target that can be referenced in a `Target` in order to facilitate deploying to a runtime that does not have a 1P integration with Cloud Deploy.
+ "annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
+ "a_key": "A String",
+ },
+ "createTime": "A String", # Output only. Time at which the `CustomTargetType` was created.
+ "customActions": { # CustomTargetSkaffoldActions represents the `CustomTargetType` configuration using Skaffold custom actions. # Configures render and deploy for the `CustomTargetType` using Skaffold custom actions.
+ "deployAction": "A String", # Required. The Skaffold custom action responsible for deploy operations.
+ "includeSkaffoldModules": [ # Optional. List of Skaffold modules Cloud Deploy will include in the Skaffold Config as required before performing diagnose.
+ { # Skaffold Config modules and their remote source.
+ "configs": [ # Optional. The Skaffold Config modules to use from the specified source.
+ "A String",
+ ],
+ "git": { # Git repository containing Skaffold Config modules. # Remote git repository containing the Skaffold Config modules.
+ "path": "A String", # Optional. Relative path from the repository root to the Skaffold file.
+ "ref": "A String", # Optional. Git ref the package should be cloned from.
+ "repo": "A String", # Required. Git repository the package should be cloned from.
+ },
+ "googleCloudStorage": { # Cloud Storage bucket containing Skaffold Config modules. # Cloud Storage bucket containing the Skaffold Config modules.
+ "path": "A String", # Optional. Relative path from the source to the Skaffold file.
+ "source": "A String", # Required. Cloud Storage source paths to copy recursively. For example, providing "gs://my-bucket/dir/configs/*" will result in Skaffold copying all files within the "dir/configs" directory in the bucket "my-bucket".
+ },
+ },
+ ],
+ "renderAction": "A String", # Optional. The Skaffold custom action responsible for render operations. If not provided then Cloud Deploy will perform the render operations via `skaffold render`.
+ },
+ "customTargetTypeId": "A String", # Output only. Resource id of the `CustomTargetType`.
+ "description": "A String", # Optional. Description of the `CustomTargetType`. Max length is 255 characters.
+ "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
+ "a_key": "A String",
+ },
+ "name": "A String", # Optional. Name of the `CustomTargetType`. Format is `projects/{project}/locations/{location}/customTargetTypes/a-z{0,62}`.
+ "uid": "A String", # Output only. Unique identifier of the `CustomTargetType`.
+ "updateTime": "A String", # Output only. Most recent time at which the `CustomTargetType` was updated.
+}
+
+
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists CustomTargetTypes in a given project and location.
+
+Args:
+ parent: string, Required. The parent that owns this collection of custom target types. Format must be `projects/{project_id}/locations/{location_name}`. (required)
+ filter: string, Optional. Filter custom target types to be returned. See https://google.aip.dev/160 for more details.
+ orderBy: string, Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.
+ pageSize: integer, Optional. The maximum number of `CustomTargetType` objects to return. The service may return fewer than this value. If unspecified, at most 50 `CustomTargetType` objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.
+ pageToken: string, Optional. A page token, received from a previous `ListCustomTargetTypes` call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response object from `ListCustomTargetTypes.`
+ "customTargetTypes": [ # The `CustomTargetType` objects.
+ { # A `CustomTargetType` resource in the Cloud Deploy API. A `CustomTargetType` defines a type of custom target that can be referenced in a `Target` in order to facilitate deploying to a runtime that does not have a 1P integration with Cloud Deploy.
+ "annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
+ "a_key": "A String",
+ },
+ "createTime": "A String", # Output only. Time at which the `CustomTargetType` was created.
+ "customActions": { # CustomTargetSkaffoldActions represents the `CustomTargetType` configuration using Skaffold custom actions. # Configures render and deploy for the `CustomTargetType` using Skaffold custom actions.
+ "deployAction": "A String", # Required. The Skaffold custom action responsible for deploy operations.
+ "includeSkaffoldModules": [ # Optional. List of Skaffold modules Cloud Deploy will include in the Skaffold Config as required before performing diagnose.
+ { # Skaffold Config modules and their remote source.
+ "configs": [ # Optional. The Skaffold Config modules to use from the specified source.
+ "A String",
+ ],
+ "git": { # Git repository containing Skaffold Config modules. # Remote git repository containing the Skaffold Config modules.
+ "path": "A String", # Optional. Relative path from the repository root to the Skaffold file.
+ "ref": "A String", # Optional. Git ref the package should be cloned from.
+ "repo": "A String", # Required. Git repository the package should be cloned from.
+ },
+ "googleCloudStorage": { # Cloud Storage bucket containing Skaffold Config modules. # Cloud Storage bucket containing the Skaffold Config modules.
+ "path": "A String", # Optional. Relative path from the source to the Skaffold file.
+ "source": "A String", # Required. Cloud Storage source paths to copy recursively. For example, providing "gs://my-bucket/dir/configs/*" will result in Skaffold copying all files within the "dir/configs" directory in the bucket "my-bucket".
+ },
+ },
+ ],
+ "renderAction": "A String", # Optional. The Skaffold custom action responsible for render operations. If not provided then Cloud Deploy will perform the render operations via `skaffold render`.
+ },
+ "customTargetTypeId": "A String", # Output only. Resource id of the `CustomTargetType`.
+ "description": "A String", # Optional. Description of the `CustomTargetType`. Max length is 255 characters.
+ "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
+ "a_key": "A String",
+ },
+ "name": "A String", # Optional. Name of the `CustomTargetType`. Format is `projects/{project}/locations/{location}/customTargetTypes/a-z{0,62}`.
+ "uid": "A String", # Output only. Unique identifier of the `CustomTargetType`.
+ "updateTime": "A String", # Output only. Most recent time at which the `CustomTargetType` was updated.
+ },
+ ],
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+ "unreachable": [ # Locations that could not be reached.
+ "A String",
+ ],
+}
+
+
+
+ list_next()
+ Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
+
+ patch(name, allowMissing=None, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)
+ Updates a single CustomTargetType.
+
+Args:
+ name: string, Optional. Name of the `CustomTargetType`. Format is `projects/{project}/locations/{location}/customTargetTypes/a-z{0,62}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A `CustomTargetType` resource in the Cloud Deploy API. A `CustomTargetType` defines a type of custom target that can be referenced in a `Target` in order to facilitate deploying to a runtime that does not have a 1P integration with Cloud Deploy.
+ "annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
+ "a_key": "A String",
+ },
+ "createTime": "A String", # Output only. Time at which the `CustomTargetType` was created.
+ "customActions": { # CustomTargetSkaffoldActions represents the `CustomTargetType` configuration using Skaffold custom actions. # Configures render and deploy for the `CustomTargetType` using Skaffold custom actions.
+ "deployAction": "A String", # Required. The Skaffold custom action responsible for deploy operations.
+ "includeSkaffoldModules": [ # Optional. List of Skaffold modules Cloud Deploy will include in the Skaffold Config as required before performing diagnose.
+ { # Skaffold Config modules and their remote source.
+ "configs": [ # Optional. The Skaffold Config modules to use from the specified source.
+ "A String",
+ ],
+ "git": { # Git repository containing Skaffold Config modules. # Remote git repository containing the Skaffold Config modules.
+ "path": "A String", # Optional. Relative path from the repository root to the Skaffold file.
+ "ref": "A String", # Optional. Git ref the package should be cloned from.
+ "repo": "A String", # Required. Git repository the package should be cloned from.
+ },
+ "googleCloudStorage": { # Cloud Storage bucket containing Skaffold Config modules. # Cloud Storage bucket containing the Skaffold Config modules.
+ "path": "A String", # Optional. Relative path from the source to the Skaffold file.
+ "source": "A String", # Required. Cloud Storage source paths to copy recursively. For example, providing "gs://my-bucket/dir/configs/*" will result in Skaffold copying all files within the "dir/configs" directory in the bucket "my-bucket".
+ },
+ },
+ ],
+ "renderAction": "A String", # Optional. The Skaffold custom action responsible for render operations. If not provided then Cloud Deploy will perform the render operations via `skaffold render`.
+ },
+ "customTargetTypeId": "A String", # Output only. Resource id of the `CustomTargetType`.
+ "description": "A String", # Optional. Description of the `CustomTargetType`. Max length is 255 characters.
+ "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
+ "a_key": "A String",
+ },
+ "name": "A String", # Optional. Name of the `CustomTargetType`. Format is `projects/{project}/locations/{location}/customTargetTypes/a-z{0,62}`.
+ "uid": "A String", # Output only. Unique identifier of the `CustomTargetType`.
+ "updateTime": "A String", # Output only. Most recent time at which the `CustomTargetType` was updated.
+}
+
+ allowMissing: boolean, Optional. If set to true, updating a `CustomTargetType` that does not exist will result in the creation of a new `CustomTargetType`.
+ requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+ updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the `CustomTargetType` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
+ validateOnly: boolean, Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # 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). # The error result of the operation in case of failure or cancellation.
+ "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.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automationRuns.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automationRuns.html
index 1c0578c7f78..fd9e556541f 100644
--- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automationRuns.html
+++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automationRuns.html
@@ -133,15 +133,15 @@ Method Details
Returns:
An object of the form:
- { # An `AutomationRun` resource in the Cloud Deploy API. An `AutomationRun` represents an automation execution instance of an automation rule.
+ { # An `AutomationRun` resource in the Cloud Deploy API. An `AutomationRun` represents an execution instance of an automation rule.
"advanceRolloutOperation": { # Contains the information of an automated advance-rollout operation. # Output only. Advances a rollout to the next phase.
- "destinationPhase": "A String", # Output only. The phase to which the rollout will be advanced to.
+ "destinationPhase": "A String", # Output only. The phase the rollout will be advanced to.
"rollout": "A String", # Output only. The name of the rollout that initiates the `AutomationRun`.
"sourcePhase": "A String", # Output only. The phase of a deployment that initiated the operation.
"wait": "A String", # Output only. How long the operation will be paused.
},
"automationId": "A String", # Output only. The ID of the automation that initiated the operation.
- "automationSnapshot": { # An `Automation` resource in the Cloud Deploy API. An `Automation` enables the automation of manually driven actions for a Delivery Pipeline, which includes Release promotion amongst Targets, Rollout repair and Rollout deployment strategy advancement. The intention of Automation is to reduce manual intervention in the continuous delivery process. # Output only. Snapshot of the Automation taken at AutomationRun creation time.
+ "automationSnapshot": { # An `Automation` resource in the Cloud Deploy API. An `Automation` enables the automation of manually driven actions for a Delivery Pipeline, which includes Release promotion among Targets, Rollout repair and Rollout deployment strategy advancement. The intention of Automation is to reduce manual intervention in the continuous delivery process. # Output only. Snapshot of the Automation taken at AutomationRun creation time.
"annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. Annotations must meet the following constraints: * Annotations are key/value pairs. * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (`/`). * The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character (`[a-z0-9A-Z]`) with dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between. * The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots(`.`), not longer than 253 characters in total, followed by a slash (`/`). See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set for more details.
"a_key": "A String",
},
@@ -156,7 +156,7 @@ Method Details
{ # `AutomationRule` defines the automation activities.
"advanceRolloutRule": { # The `AdvanceRollout` automation rule will automatically advance a successful Rollout to the next phase. # Optional. The `AdvanceRolloutRule` will automatically advance a successful Rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -172,7 +172,7 @@ Method Details
},
"promoteReleaseRule": { # `PromoteRelease` rule will automatically promote a release from the current target to a specified target. # Optional. `PromoteReleaseRule` will automatically promote a release from the current target to a specified target.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -187,7 +187,7 @@ Method Details
},
"repairRolloutRule": { # The `RepairRolloutRule` automation rule will automatically repair a failed `Rollout`. # Optional. The `RepairRolloutRule` will automatically repair a failed rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the 'Automation' rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -202,7 +202,7 @@ Method Details
"repairModes": [ # Required. Defines the types of automatic repair actions for failed jobs.
{ # Configuration of the repair action.
"retry": { # Retries the failed job. # Optional. Retries a failed job.
- "attempts": "A String", # Required. Total number of retries. Retry will skipped if set to 0; The minimum value is 1, and the maximum value is 10.
+ "attempts": "A String", # Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10.
"backoffMode": "A String", # Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if `wait` is 0.
"wait": "A String", # Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d.
},
@@ -234,7 +234,7 @@ Method Details
},
"createTime": "A String", # Output only. Time at which the `AutomationRun` was created.
"etag": "A String", # Output only. The weak etag of the `AutomationRun` resource. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
- "expireTime": "A String", # Output only. Time the `AutomationRun` will expire. An `AutomationRun` will expire after 14 days from its creation date.
+ "expireTime": "A String", # Output only. Time the `AutomationRun` expires. An `AutomationRun` expires after 14 days from its creation date.
"name": "A String", # Output only. Name of the `AutomationRun`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}`.
"promoteReleaseOperation": { # Contains the information of an automated promote-release operation. # Output only. Promotes a release to a specified 'Target'.
"phase": "A String", # Output only. The starting phase of the rollout created by this operation.
@@ -244,6 +244,8 @@ Method Details
},
"repairRolloutOperation": { # Contains the information for an automated `repair rollout` operation. # Output only. Repairs a failed 'Rollout'.
"currentRepairModeIndex": "A String", # Output only. The index of the current repair action in the repair sequence.
+ "jobId": "A String", # Output only. The job ID for the Job to repair.
+ "phaseId": "A String", # Output only. The phase ID of the phase that includes the job being repaired.
"repairPhases": [ # Output only. Records of the repair attempts. Each repair phase may have multiple retry attempts or single rollback attempt.
{ # RepairPhase tracks the repair attempts that have been made for each `RepairMode` specified in the `Automation` resource.
"retry": { # RetryPhase contains the retry attempts and the metadata for initiating a new attempt. # Output only. Records of the retry attempts for retry repair mode.
@@ -273,7 +275,7 @@ Method Details
"ruleId": "A String", # Output only. The ID of the automation rule that initiated the operation.
"serviceAccount": "A String", # Output only. Email address of the user-managed IAM service account that performs the operations against Cloud Deploy resources.
"state": "A String", # Output only. Current state of the `AutomationRun`.
- "stateDescription": "A String", # Output only. Explains the current state of the `AutomationRun`. Present only an explanation is needed.
+ "stateDescription": "A String", # Output only. Explains the current state of the `AutomationRun`. Present only when an explanation is needed.
"targetId": "A String", # Output only. The ID of the target that represents the promotion stage that initiates the `AutomationRun`. The value of this field is the last segment of a target name.
"updateTime": "A String", # Output only. Time at which the automationRun was updated.
"waitUntilTime": "A String", # Output only. Earliest time the `AutomationRun` will attempt to resume. Wait-time is configured by `wait` in automation rule.
@@ -285,7 +287,7 @@ Method Details
Lists AutomationRuns in a given project and location.
Args:
- parent: string, Required. The parent, which owns this collection of automationRuns. Format must be `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}`. (required)
+ parent: string, Required. The parent `Delivery Pipeline`, which owns this collection of automationRuns. Format must be `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}`. (required)
filter: string, Filter automationRuns to be returned. All fields can be used in the filter.
orderBy: string, Field to sort by.
pageSize: integer, The maximum number of automationRuns to return. The service may return fewer than this value. If unspecified, at most 50 automationRuns will be returned. The maximum value is 1000; values above 1000 will be set to 1000.
@@ -300,15 +302,15 @@ Method Details
{ # The response object from `ListAutomationRuns`.
"automationRuns": [ # The `AutomationRuns` objects.
- { # An `AutomationRun` resource in the Cloud Deploy API. An `AutomationRun` represents an automation execution instance of an automation rule.
+ { # An `AutomationRun` resource in the Cloud Deploy API. An `AutomationRun` represents an execution instance of an automation rule.
"advanceRolloutOperation": { # Contains the information of an automated advance-rollout operation. # Output only. Advances a rollout to the next phase.
- "destinationPhase": "A String", # Output only. The phase to which the rollout will be advanced to.
+ "destinationPhase": "A String", # Output only. The phase the rollout will be advanced to.
"rollout": "A String", # Output only. The name of the rollout that initiates the `AutomationRun`.
"sourcePhase": "A String", # Output only. The phase of a deployment that initiated the operation.
"wait": "A String", # Output only. How long the operation will be paused.
},
"automationId": "A String", # Output only. The ID of the automation that initiated the operation.
- "automationSnapshot": { # An `Automation` resource in the Cloud Deploy API. An `Automation` enables the automation of manually driven actions for a Delivery Pipeline, which includes Release promotion amongst Targets, Rollout repair and Rollout deployment strategy advancement. The intention of Automation is to reduce manual intervention in the continuous delivery process. # Output only. Snapshot of the Automation taken at AutomationRun creation time.
+ "automationSnapshot": { # An `Automation` resource in the Cloud Deploy API. An `Automation` enables the automation of manually driven actions for a Delivery Pipeline, which includes Release promotion among Targets, Rollout repair and Rollout deployment strategy advancement. The intention of Automation is to reduce manual intervention in the continuous delivery process. # Output only. Snapshot of the Automation taken at AutomationRun creation time.
"annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. Annotations must meet the following constraints: * Annotations are key/value pairs. * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (`/`). * The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character (`[a-z0-9A-Z]`) with dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between. * The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots(`.`), not longer than 253 characters in total, followed by a slash (`/`). See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set for more details.
"a_key": "A String",
},
@@ -323,7 +325,7 @@ Method Details
{ # `AutomationRule` defines the automation activities.
"advanceRolloutRule": { # The `AdvanceRollout` automation rule will automatically advance a successful Rollout to the next phase. # Optional. The `AdvanceRolloutRule` will automatically advance a successful Rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -339,7 +341,7 @@ Method Details
},
"promoteReleaseRule": { # `PromoteRelease` rule will automatically promote a release from the current target to a specified target. # Optional. `PromoteReleaseRule` will automatically promote a release from the current target to a specified target.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -354,7 +356,7 @@ Method Details
},
"repairRolloutRule": { # The `RepairRolloutRule` automation rule will automatically repair a failed `Rollout`. # Optional. The `RepairRolloutRule` will automatically repair a failed rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the 'Automation' rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -369,7 +371,7 @@ Method Details
"repairModes": [ # Required. Defines the types of automatic repair actions for failed jobs.
{ # Configuration of the repair action.
"retry": { # Retries the failed job. # Optional. Retries a failed job.
- "attempts": "A String", # Required. Total number of retries. Retry will skipped if set to 0; The minimum value is 1, and the maximum value is 10.
+ "attempts": "A String", # Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10.
"backoffMode": "A String", # Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if `wait` is 0.
"wait": "A String", # Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d.
},
@@ -401,7 +403,7 @@ Method Details
},
"createTime": "A String", # Output only. Time at which the `AutomationRun` was created.
"etag": "A String", # Output only. The weak etag of the `AutomationRun` resource. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
- "expireTime": "A String", # Output only. Time the `AutomationRun` will expire. An `AutomationRun` will expire after 14 days from its creation date.
+ "expireTime": "A String", # Output only. Time the `AutomationRun` expires. An `AutomationRun` expires after 14 days from its creation date.
"name": "A String", # Output only. Name of the `AutomationRun`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}`.
"promoteReleaseOperation": { # Contains the information of an automated promote-release operation. # Output only. Promotes a release to a specified 'Target'.
"phase": "A String", # Output only. The starting phase of the rollout created by this operation.
@@ -411,6 +413,8 @@ Method Details
},
"repairRolloutOperation": { # Contains the information for an automated `repair rollout` operation. # Output only. Repairs a failed 'Rollout'.
"currentRepairModeIndex": "A String", # Output only. The index of the current repair action in the repair sequence.
+ "jobId": "A String", # Output only. The job ID for the Job to repair.
+ "phaseId": "A String", # Output only. The phase ID of the phase that includes the job being repaired.
"repairPhases": [ # Output only. Records of the repair attempts. Each repair phase may have multiple retry attempts or single rollback attempt.
{ # RepairPhase tracks the repair attempts that have been made for each `RepairMode` specified in the `Automation` resource.
"retry": { # RetryPhase contains the retry attempts and the metadata for initiating a new attempt. # Output only. Records of the retry attempts for retry repair mode.
@@ -440,7 +444,7 @@ Method Details
"ruleId": "A String", # Output only. The ID of the automation rule that initiated the operation.
"serviceAccount": "A String", # Output only. Email address of the user-managed IAM service account that performs the operations against Cloud Deploy resources.
"state": "A String", # Output only. Current state of the `AutomationRun`.
- "stateDescription": "A String", # Output only. Explains the current state of the `AutomationRun`. Present only an explanation is needed.
+ "stateDescription": "A String", # Output only. Explains the current state of the `AutomationRun`. Present only when an explanation is needed.
"targetId": "A String", # Output only. The ID of the target that represents the promotion stage that initiates the `AutomationRun`. The value of this field is the last segment of a target name.
"updateTime": "A String", # Output only. Time at which the automationRun was updated.
"waitUntilTime": "A String", # Output only. Earliest time the `AutomationRun` will attempt to resume. Wait-time is configured by `wait` in automation rule.
diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automations.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automations.html
index 013c3164b0b..149a263ab1a 100644
--- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automations.html
+++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automations.html
@@ -110,7 +110,7 @@ Method Details
body: object, The request body.
The object takes the form of:
-{ # An `Automation` resource in the Cloud Deploy API. An `Automation` enables the automation of manually driven actions for a Delivery Pipeline, which includes Release promotion amongst Targets, Rollout repair and Rollout deployment strategy advancement. The intention of Automation is to reduce manual intervention in the continuous delivery process.
+{ # An `Automation` resource in the Cloud Deploy API. An `Automation` enables the automation of manually driven actions for a Delivery Pipeline, which includes Release promotion among Targets, Rollout repair and Rollout deployment strategy advancement. The intention of Automation is to reduce manual intervention in the continuous delivery process.
"annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. Annotations must meet the following constraints: * Annotations are key/value pairs. * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (`/`). * The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character (`[a-z0-9A-Z]`) with dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between. * The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots(`.`), not longer than 253 characters in total, followed by a slash (`/`). See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set for more details.
"a_key": "A String",
},
@@ -125,7 +125,7 @@ Method Details
{ # `AutomationRule` defines the automation activities.
"advanceRolloutRule": { # The `AdvanceRollout` automation rule will automatically advance a successful Rollout to the next phase. # Optional. The `AdvanceRolloutRule` will automatically advance a successful Rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -141,7 +141,7 @@ Method Details
},
"promoteReleaseRule": { # `PromoteRelease` rule will automatically promote a release from the current target to a specified target. # Optional. `PromoteReleaseRule` will automatically promote a release from the current target to a specified target.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -156,7 +156,7 @@ Method Details
},
"repairRolloutRule": { # The `RepairRolloutRule` automation rule will automatically repair a failed `Rollout`. # Optional. The `RepairRolloutRule` will automatically repair a failed rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the 'Automation' rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -171,7 +171,7 @@ Method Details
"repairModes": [ # Required. Defines the types of automatic repair actions for failed jobs.
{ # Configuration of the repair action.
"retry": { # Retries the failed job. # Optional. Retries a failed job.
- "attempts": "A String", # Required. Total number of retries. Retry will skipped if set to 0; The minimum value is 1, and the maximum value is 10.
+ "attempts": "A String", # Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10.
"backoffMode": "A String", # Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if `wait` is 0.
"wait": "A String", # Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d.
},
@@ -287,7 +287,7 @@ Method Details
Returns:
An object of the form:
- { # An `Automation` resource in the Cloud Deploy API. An `Automation` enables the automation of manually driven actions for a Delivery Pipeline, which includes Release promotion amongst Targets, Rollout repair and Rollout deployment strategy advancement. The intention of Automation is to reduce manual intervention in the continuous delivery process.
+ { # An `Automation` resource in the Cloud Deploy API. An `Automation` enables the automation of manually driven actions for a Delivery Pipeline, which includes Release promotion among Targets, Rollout repair and Rollout deployment strategy advancement. The intention of Automation is to reduce manual intervention in the continuous delivery process.
"annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. Annotations must meet the following constraints: * Annotations are key/value pairs. * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (`/`). * The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character (`[a-z0-9A-Z]`) with dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between. * The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots(`.`), not longer than 253 characters in total, followed by a slash (`/`). See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set for more details.
"a_key": "A String",
},
@@ -302,7 +302,7 @@ Method Details
{ # `AutomationRule` defines the automation activities.
"advanceRolloutRule": { # The `AdvanceRollout` automation rule will automatically advance a successful Rollout to the next phase. # Optional. The `AdvanceRolloutRule` will automatically advance a successful Rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -318,7 +318,7 @@ Method Details
},
"promoteReleaseRule": { # `PromoteRelease` rule will automatically promote a release from the current target to a specified target. # Optional. `PromoteReleaseRule` will automatically promote a release from the current target to a specified target.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -333,7 +333,7 @@ Method Details
},
"repairRolloutRule": { # The `RepairRolloutRule` automation rule will automatically repair a failed `Rollout`. # Optional. The `RepairRolloutRule` will automatically repair a failed rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the 'Automation' rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -348,7 +348,7 @@ Method Details
"repairModes": [ # Required. Defines the types of automatic repair actions for failed jobs.
{ # Configuration of the repair action.
"retry": { # Retries the failed job. # Optional. Retries a failed job.
- "attempts": "A String", # Required. Total number of retries. Retry will skipped if set to 0; The minimum value is 1, and the maximum value is 10.
+ "attempts": "A String", # Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10.
"backoffMode": "A String", # Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if `wait` is 0.
"wait": "A String", # Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d.
},
@@ -385,7 +385,7 @@ Method Details
Lists Automations in a given project and location.
Args:
- parent: string, Required. The parent, which owns this collection of automations. Format must be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`. (required)
+ parent: string, Required. The parent `Delivery Pipeline`, which owns this collection of automations. Format must be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`. (required)
filter: string, Filter automations to be returned. All fields can be used in the filter.
orderBy: string, Field to sort by.
pageSize: integer, The maximum number of automations to return. The service may return fewer than this value. If unspecified, at most 50 automations will be returned. The maximum value is 1000; values above 1000 will be set to 1000.
@@ -399,8 +399,8 @@ Method Details
An object of the form:
{ # The response object from `ListAutomations`.
- "automations": [ # The `Automations` objects.
- { # An `Automation` resource in the Cloud Deploy API. An `Automation` enables the automation of manually driven actions for a Delivery Pipeline, which includes Release promotion amongst Targets, Rollout repair and Rollout deployment strategy advancement. The intention of Automation is to reduce manual intervention in the continuous delivery process.
+ "automations": [ # The `Automation` objects.
+ { # An `Automation` resource in the Cloud Deploy API. An `Automation` enables the automation of manually driven actions for a Delivery Pipeline, which includes Release promotion among Targets, Rollout repair and Rollout deployment strategy advancement. The intention of Automation is to reduce manual intervention in the continuous delivery process.
"annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. Annotations must meet the following constraints: * Annotations are key/value pairs. * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (`/`). * The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character (`[a-z0-9A-Z]`) with dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between. * The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots(`.`), not longer than 253 characters in total, followed by a slash (`/`). See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set for more details.
"a_key": "A String",
},
@@ -415,7 +415,7 @@ Method Details
{ # `AutomationRule` defines the automation activities.
"advanceRolloutRule": { # The `AdvanceRollout` automation rule will automatically advance a successful Rollout to the next phase. # Optional. The `AdvanceRolloutRule` will automatically advance a successful Rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -431,7 +431,7 @@ Method Details
},
"promoteReleaseRule": { # `PromoteRelease` rule will automatically promote a release from the current target to a specified target. # Optional. `PromoteReleaseRule` will automatically promote a release from the current target to a specified target.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -446,7 +446,7 @@ Method Details
},
"repairRolloutRule": { # The `RepairRolloutRule` automation rule will automatically repair a failed `Rollout`. # Optional. The `RepairRolloutRule` will automatically repair a failed rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the 'Automation' rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -461,7 +461,7 @@ Method Details
"repairModes": [ # Required. Defines the types of automatic repair actions for failed jobs.
{ # Configuration of the repair action.
"retry": { # Retries the failed job. # Optional. Retries a failed job.
- "attempts": "A String", # Required. Total number of retries. Retry will skipped if set to 0; The minimum value is 1, and the maximum value is 10.
+ "attempts": "A String", # Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10.
"backoffMode": "A String", # Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if `wait` is 0.
"wait": "A String", # Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d.
},
@@ -522,7 +522,7 @@ Method Details
body: object, The request body.
The object takes the form of:
-{ # An `Automation` resource in the Cloud Deploy API. An `Automation` enables the automation of manually driven actions for a Delivery Pipeline, which includes Release promotion amongst Targets, Rollout repair and Rollout deployment strategy advancement. The intention of Automation is to reduce manual intervention in the continuous delivery process.
+{ # An `Automation` resource in the Cloud Deploy API. An `Automation` enables the automation of manually driven actions for a Delivery Pipeline, which includes Release promotion among Targets, Rollout repair and Rollout deployment strategy advancement. The intention of Automation is to reduce manual intervention in the continuous delivery process.
"annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. Annotations must meet the following constraints: * Annotations are key/value pairs. * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (`/`). * The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character (`[a-z0-9A-Z]`) with dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between. * The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots(`.`), not longer than 253 characters in total, followed by a slash (`/`). See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set for more details.
"a_key": "A String",
},
@@ -537,7 +537,7 @@ Method Details
{ # `AutomationRule` defines the automation activities.
"advanceRolloutRule": { # The `AdvanceRollout` automation rule will automatically advance a successful Rollout to the next phase. # Optional. The `AdvanceRolloutRule` will automatically advance a successful Rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -553,7 +553,7 @@ Method Details
},
"promoteReleaseRule": { # `PromoteRelease` rule will automatically promote a release from the current target to a specified target. # Optional. `PromoteReleaseRule` will automatically promote a release from the current target to a specified target.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -568,7 +568,7 @@ Method Details
},
"repairRolloutRule": { # The `RepairRolloutRule` automation rule will automatically repair a failed `Rollout`. # Optional. The `RepairRolloutRule` will automatically repair a failed rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the 'Automation' rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -583,7 +583,7 @@ Method Details
"repairModes": [ # Required. Defines the types of automatic repair actions for failed jobs.
{ # Configuration of the repair action.
"retry": { # Retries the failed job. # Optional. Retries a failed job.
- "attempts": "A String", # Required. Total number of retries. Retry will skipped if set to 0; The minimum value is 1, and the maximum value is 10.
+ "attempts": "A String", # Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10.
"backoffMode": "A String", # Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if `wait` is 0.
"wait": "A String", # Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d.
},
diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html
index 460d822c035..fce5aa7ca26 100644
--- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html
+++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html
@@ -146,7 +146,7 @@ Method Details
"status": True or False, # True if the Pipeline is in a valid state. Otherwise at least one condition in `PipelineCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.
"updateTime": "A String", # Last time the condition was updated.
},
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -224,6 +224,15 @@ Method Details
"runtimeConfig": { # RuntimeConfig contains the runtime specific configurations for a deployment strategy. # Optional. Runtime specific configurations for the deployment strategy. The runtime configuration is used to determine how Cloud Deploy will split traffic to enable a progressive deployment.
"cloudRun": { # CloudRunConfig contains the Cloud Run runtime configuration. # Cloud Run runtime configuration.
"automaticTrafficControl": True or False, # Whether Cloud Deploy should update the traffic stanza in a Cloud Run Service on the user's behalf to facilitate traffic splitting. This is required to be true for CanaryDeployments, but optional for CustomCanaryDeployments.
+ "canaryRevisionTags": [ # Optional. A list of tags that are added to the canary revision while the canary deployment is in progress.
+ "A String",
+ ],
+ "priorRevisionTags": [ # Optional. A list of tags that are added to the prior revision while the canary deployment is in progress.
+ "A String",
+ ],
+ "stableRevisionTags": [ # Optional. A list of tags that are added to the final stable revision after the canary deployment is completed.
+ "A String",
+ ],
},
"kubernetes": { # KubernetesConfig contains the Kubernetes runtime configuration. # Kubernetes runtime configuration.
"gatewayServiceMesh": { # Information about the Kubernetes Gateway API service mesh configuration. # Kubernetes Gateway API service mesh configuration.
@@ -358,7 +367,7 @@ Method Details
"status": True or False, # True if the Pipeline is in a valid state. Otherwise at least one condition in `PipelineCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.
"updateTime": "A String", # Last time the condition was updated.
},
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -436,6 +445,15 @@ Method Details
"runtimeConfig": { # RuntimeConfig contains the runtime specific configurations for a deployment strategy. # Optional. Runtime specific configurations for the deployment strategy. The runtime configuration is used to determine how Cloud Deploy will split traffic to enable a progressive deployment.
"cloudRun": { # CloudRunConfig contains the Cloud Run runtime configuration. # Cloud Run runtime configuration.
"automaticTrafficControl": True or False, # Whether Cloud Deploy should update the traffic stanza in a Cloud Run Service on the user's behalf to facilitate traffic splitting. This is required to be true for CanaryDeployments, but optional for CustomCanaryDeployments.
+ "canaryRevisionTags": [ # Optional. A list of tags that are added to the canary revision while the canary deployment is in progress.
+ "A String",
+ ],
+ "priorRevisionTags": [ # Optional. A list of tags that are added to the prior revision while the canary deployment is in progress.
+ "A String",
+ ],
+ "stableRevisionTags": [ # Optional. A list of tags that are added to the final stable revision after the canary deployment is completed.
+ "A String",
+ ],
},
"kubernetes": { # KubernetesConfig contains the Kubernetes runtime configuration. # Kubernetes runtime configuration.
"gatewayServiceMesh": { # Information about the Kubernetes Gateway API service mesh configuration. # Kubernetes Gateway API service mesh configuration.
@@ -553,7 +571,7 @@ Method Details
"status": True or False, # True if the Pipeline is in a valid state. Otherwise at least one condition in `PipelineCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.
"updateTime": "A String", # Last time the condition was updated.
},
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -631,6 +649,15 @@ Method Details
"runtimeConfig": { # RuntimeConfig contains the runtime specific configurations for a deployment strategy. # Optional. Runtime specific configurations for the deployment strategy. The runtime configuration is used to determine how Cloud Deploy will split traffic to enable a progressive deployment.
"cloudRun": { # CloudRunConfig contains the Cloud Run runtime configuration. # Cloud Run runtime configuration.
"automaticTrafficControl": True or False, # Whether Cloud Deploy should update the traffic stanza in a Cloud Run Service on the user's behalf to facilitate traffic splitting. This is required to be true for CanaryDeployments, but optional for CustomCanaryDeployments.
+ "canaryRevisionTags": [ # Optional. A list of tags that are added to the canary revision while the canary deployment is in progress.
+ "A String",
+ ],
+ "priorRevisionTags": [ # Optional. A list of tags that are added to the prior revision while the canary deployment is in progress.
+ "A String",
+ ],
+ "stableRevisionTags": [ # Optional. A list of tags that are added to the final stable revision after the canary deployment is completed.
+ "A String",
+ ],
},
"kubernetes": { # KubernetesConfig contains the Kubernetes runtime configuration. # Kubernetes runtime configuration.
"gatewayServiceMesh": { # Information about the Kubernetes Gateway API service mesh configuration. # Kubernetes Gateway API service mesh configuration.
@@ -709,7 +736,7 @@ Method Details
"status": True or False, # True if the Pipeline is in a valid state. Otherwise at least one condition in `PipelineCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.
"updateTime": "A String", # Last time the condition was updated.
},
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -787,6 +814,15 @@ Method Details
"runtimeConfig": { # RuntimeConfig contains the runtime specific configurations for a deployment strategy. # Optional. Runtime specific configurations for the deployment strategy. The runtime configuration is used to determine how Cloud Deploy will split traffic to enable a progressive deployment.
"cloudRun": { # CloudRunConfig contains the Cloud Run runtime configuration. # Cloud Run runtime configuration.
"automaticTrafficControl": True or False, # Whether Cloud Deploy should update the traffic stanza in a Cloud Run Service on the user's behalf to facilitate traffic splitting. This is required to be true for CanaryDeployments, but optional for CustomCanaryDeployments.
+ "canaryRevisionTags": [ # Optional. A list of tags that are added to the canary revision while the canary deployment is in progress.
+ "A String",
+ ],
+ "priorRevisionTags": [ # Optional. A list of tags that are added to the prior revision while the canary deployment is in progress.
+ "A String",
+ ],
+ "stableRevisionTags": [ # Optional. A list of tags that are added to the final stable revision after the canary deployment is completed.
+ "A String",
+ ],
},
"kubernetes": { # KubernetesConfig contains the Kubernetes runtime configuration. # Kubernetes runtime configuration.
"gatewayServiceMesh": { # Information about the Kubernetes Gateway API service mesh configuration. # Kubernetes Gateway API service mesh configuration.
@@ -908,6 +944,11 @@ Method Details
"A String",
],
},
+ "custom": { # CustomMetadata contains information from a user defined operation. # Output only. Custom metadata provided by user defined `Rollout` operations.
+ "values": { # Output only. Key-value pairs provided by the user defined operation.
+ "a_key": "A String",
+ },
+ },
},
"name": "A String", # Optional. Name of the `Rollout`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}`.
"phases": [ # Output only. The phases that represent the workflows of this `Rollout`.
@@ -1132,6 +1173,11 @@ Method Details
"A String",
],
},
+ "custom": { # CustomMetadata contains information from a user defined operation. # Output only. Custom metadata provided by user defined `Rollout` operations.
+ "values": { # Output only. Key-value pairs provided by the user defined operation.
+ "a_key": "A String",
+ },
+ },
},
"name": "A String", # Optional. Name of the `Rollout`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}`.
"phases": [ # Output only. The phases that represent the workflows of this `Rollout`.
diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html
index e348612e882..b2cbc870d96 100644
--- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html
+++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html
@@ -151,14 +151,51 @@ Method Details
"releaseReadyCondition": { # ReleaseReadyCondition contains information around the status of the Release. If a release is not ready, you cannot create a rollout with the release. # Details around the Releases's overall status.
"status": True or False, # True if the Release is in a valid state. Otherwise at least one condition in `ReleaseCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Release.
},
- "skaffoldSupportedCondition": { # SkaffoldSupportedCondition contains information about when support for the release's version of skaffold ends. # Details around the support state of the release's skaffold version.
- "maintenanceModeTime": "A String", # The time at which this release's version of skaffold will enter maintenance mode.
- "skaffoldSupportState": "A String", # The skaffold support state for this release's version of skaffold.
- "status": True or False, # True if the version of skaffold used by this release is supported.
- "supportExpirationTime": "A String", # The time at which this release's version of skaffold will no longer be supported.
+ "skaffoldSupportedCondition": { # SkaffoldSupportedCondition contains information about when support for the release's version of Skaffold ends. # Details around the support state of the release's Skaffold version.
+ "maintenanceModeTime": "A String", # The time at which this release's version of Skaffold will enter maintenance mode.
+ "skaffoldSupportState": "A String", # The Skaffold support state for this release's version of Skaffold.
+ "status": True or False, # True if the version of Skaffold used by this release is supported.
+ "supportExpirationTime": "A String", # The time at which this release's version of Skaffold will no longer be supported.
},
},
"createTime": "A String", # Output only. Time at which the `Release` was created.
+ "customTargetTypeSnapshots": [ # Output only. Snapshot of the custom target types referenced by the targets taken at release creation time.
+ { # A `CustomTargetType` resource in the Cloud Deploy API. A `CustomTargetType` defines a type of custom target that can be referenced in a `Target` in order to facilitate deploying to a runtime that does not have a 1P integration with Cloud Deploy.
+ "annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
+ "a_key": "A String",
+ },
+ "createTime": "A String", # Output only. Time at which the `CustomTargetType` was created.
+ "customActions": { # CustomTargetSkaffoldActions represents the `CustomTargetType` configuration using Skaffold custom actions. # Configures render and deploy for the `CustomTargetType` using Skaffold custom actions.
+ "deployAction": "A String", # Required. The Skaffold custom action responsible for deploy operations.
+ "includeSkaffoldModules": [ # Optional. List of Skaffold modules Cloud Deploy will include in the Skaffold Config as required before performing diagnose.
+ { # Skaffold Config modules and their remote source.
+ "configs": [ # Optional. The Skaffold Config modules to use from the specified source.
+ "A String",
+ ],
+ "git": { # Git repository containing Skaffold Config modules. # Remote git repository containing the Skaffold Config modules.
+ "path": "A String", # Optional. Relative path from the repository root to the Skaffold file.
+ "ref": "A String", # Optional. Git ref the package should be cloned from.
+ "repo": "A String", # Required. Git repository the package should be cloned from.
+ },
+ "googleCloudStorage": { # Cloud Storage bucket containing Skaffold Config modules. # Cloud Storage bucket containing the Skaffold Config modules.
+ "path": "A String", # Optional. Relative path from the source to the Skaffold file.
+ "source": "A String", # Required. Cloud Storage source paths to copy recursively. For example, providing "gs://my-bucket/dir/configs/*" will result in Skaffold copying all files within the "dir/configs" directory in the bucket "my-bucket".
+ },
+ },
+ ],
+ "renderAction": "A String", # Optional. The Skaffold custom action responsible for render operations. If not provided then Cloud Deploy will perform the render operations via `skaffold render`.
+ },
+ "customTargetTypeId": "A String", # Output only. Resource id of the `CustomTargetType`.
+ "description": "A String", # Optional. Description of the `CustomTargetType`. Max length is 255 characters.
+ "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
+ "a_key": "A String",
+ },
+ "name": "A String", # Optional. Name of the `CustomTargetType`. Format is `projects/{project}/locations/{location}/customTargetTypes/a-z{0,62}`.
+ "uid": "A String", # Output only. Unique identifier of the `CustomTargetType`.
+ "updateTime": "A String", # Output only. Most recent time at which the `CustomTargetType` was updated.
+ },
+ ],
"deliveryPipelineSnapshot": { # A `DeliveryPipeline` resource in the Cloud Deploy API. A `DeliveryPipeline` defines a pipeline through which a Skaffold configuration can progress. # Output only. Snapshot of the parent pipeline taken at release creation time.
"annotations": { # User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy.
"a_key": "A String",
@@ -168,7 +205,7 @@ Method Details
"status": True or False, # True if the Pipeline is in a valid state. Otherwise at least one condition in `PipelineCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.
"updateTime": "A String", # Last time the condition was updated.
},
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -246,6 +283,15 @@ Method Details
"runtimeConfig": { # RuntimeConfig contains the runtime specific configurations for a deployment strategy. # Optional. Runtime specific configurations for the deployment strategy. The runtime configuration is used to determine how Cloud Deploy will split traffic to enable a progressive deployment.
"cloudRun": { # CloudRunConfig contains the Cloud Run runtime configuration. # Cloud Run runtime configuration.
"automaticTrafficControl": True or False, # Whether Cloud Deploy should update the traffic stanza in a Cloud Run Service on the user's behalf to facilitate traffic splitting. This is required to be true for CanaryDeployments, but optional for CustomCanaryDeployments.
+ "canaryRevisionTags": [ # Optional. A list of tags that are added to the canary revision while the canary deployment is in progress.
+ "A String",
+ ],
+ "priorRevisionTags": [ # Optional. A list of tags that are added to the prior revision while the canary deployment is in progress.
+ "A String",
+ ],
+ "stableRevisionTags": [ # Optional. A list of tags that are added to the final stable revision after the canary deployment is completed.
+ "A String",
+ ],
},
"kubernetes": { # KubernetesConfig contains the Kubernetes runtime configuration. # Kubernetes runtime configuration.
"gatewayServiceMesh": { # Information about the Kubernetes Gateway API service mesh configuration. # Kubernetes Gateway API service mesh configuration.
@@ -321,6 +367,11 @@ Method Details
"cloudRun": { # CloudRunRenderMetadata contains Cloud Run information associated with a `Release` render. # Output only. Metadata associated with rendering for Cloud Run.
"service": "A String", # Output only. The name of the Cloud Run Service in the rendered manifest. Format is `projects/{project}/locations/{location}/services/{service}`.
},
+ "custom": { # CustomMetadata contains information from a user defined operation. # Output only. Custom metadata provided by user defined render operation.
+ "values": { # Output only. Key-value pairs provided by the user defined operation.
+ "a_key": "A String",
+ },
+ },
},
"renderingBuild": "A String", # Output only. The resource name of the Cloud Build `Build` object that is used to render the manifest for this target. Format is `projects/{project}/locations/{location}/builds/{build}`.
"renderingState": "A String", # Output only. Current state of the render operation for this Target.
@@ -335,6 +386,9 @@ Method Details
"membership": "A String", # Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`.
},
"createTime": "A String", # Output only. Time at which the `Target` was created.
+ "customTarget": { # Information specifying a Custom Target. # Optional. Information specifying a Custom Target.
+ "customTargetType": "A String", # Required. The name of the CustomTargetType. Format must be `projects/{project}/locations/{location}/customTargetTypes/{custom_target_type}`.
+ },
"deployParameters": { # Optional. The deploy parameters to use for this target.
"a_key": "A String",
},
@@ -446,14 +500,51 @@ Method Details
"releaseReadyCondition": { # ReleaseReadyCondition contains information around the status of the Release. If a release is not ready, you cannot create a rollout with the release. # Details around the Releases's overall status.
"status": True or False, # True if the Release is in a valid state. Otherwise at least one condition in `ReleaseCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Release.
},
- "skaffoldSupportedCondition": { # SkaffoldSupportedCondition contains information about when support for the release's version of skaffold ends. # Details around the support state of the release's skaffold version.
- "maintenanceModeTime": "A String", # The time at which this release's version of skaffold will enter maintenance mode.
- "skaffoldSupportState": "A String", # The skaffold support state for this release's version of skaffold.
- "status": True or False, # True if the version of skaffold used by this release is supported.
- "supportExpirationTime": "A String", # The time at which this release's version of skaffold will no longer be supported.
+ "skaffoldSupportedCondition": { # SkaffoldSupportedCondition contains information about when support for the release's version of Skaffold ends. # Details around the support state of the release's Skaffold version.
+ "maintenanceModeTime": "A String", # The time at which this release's version of Skaffold will enter maintenance mode.
+ "skaffoldSupportState": "A String", # The Skaffold support state for this release's version of Skaffold.
+ "status": True or False, # True if the version of Skaffold used by this release is supported.
+ "supportExpirationTime": "A String", # The time at which this release's version of Skaffold will no longer be supported.
},
},
"createTime": "A String", # Output only. Time at which the `Release` was created.
+ "customTargetTypeSnapshots": [ # Output only. Snapshot of the custom target types referenced by the targets taken at release creation time.
+ { # A `CustomTargetType` resource in the Cloud Deploy API. A `CustomTargetType` defines a type of custom target that can be referenced in a `Target` in order to facilitate deploying to a runtime that does not have a 1P integration with Cloud Deploy.
+ "annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
+ "a_key": "A String",
+ },
+ "createTime": "A String", # Output only. Time at which the `CustomTargetType` was created.
+ "customActions": { # CustomTargetSkaffoldActions represents the `CustomTargetType` configuration using Skaffold custom actions. # Configures render and deploy for the `CustomTargetType` using Skaffold custom actions.
+ "deployAction": "A String", # Required. The Skaffold custom action responsible for deploy operations.
+ "includeSkaffoldModules": [ # Optional. List of Skaffold modules Cloud Deploy will include in the Skaffold Config as required before performing diagnose.
+ { # Skaffold Config modules and their remote source.
+ "configs": [ # Optional. The Skaffold Config modules to use from the specified source.
+ "A String",
+ ],
+ "git": { # Git repository containing Skaffold Config modules. # Remote git repository containing the Skaffold Config modules.
+ "path": "A String", # Optional. Relative path from the repository root to the Skaffold file.
+ "ref": "A String", # Optional. Git ref the package should be cloned from.
+ "repo": "A String", # Required. Git repository the package should be cloned from.
+ },
+ "googleCloudStorage": { # Cloud Storage bucket containing Skaffold Config modules. # Cloud Storage bucket containing the Skaffold Config modules.
+ "path": "A String", # Optional. Relative path from the source to the Skaffold file.
+ "source": "A String", # Required. Cloud Storage source paths to copy recursively. For example, providing "gs://my-bucket/dir/configs/*" will result in Skaffold copying all files within the "dir/configs" directory in the bucket "my-bucket".
+ },
+ },
+ ],
+ "renderAction": "A String", # Optional. The Skaffold custom action responsible for render operations. If not provided then Cloud Deploy will perform the render operations via `skaffold render`.
+ },
+ "customTargetTypeId": "A String", # Output only. Resource id of the `CustomTargetType`.
+ "description": "A String", # Optional. Description of the `CustomTargetType`. Max length is 255 characters.
+ "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
+ "a_key": "A String",
+ },
+ "name": "A String", # Optional. Name of the `CustomTargetType`. Format is `projects/{project}/locations/{location}/customTargetTypes/a-z{0,62}`.
+ "uid": "A String", # Output only. Unique identifier of the `CustomTargetType`.
+ "updateTime": "A String", # Output only. Most recent time at which the `CustomTargetType` was updated.
+ },
+ ],
"deliveryPipelineSnapshot": { # A `DeliveryPipeline` resource in the Cloud Deploy API. A `DeliveryPipeline` defines a pipeline through which a Skaffold configuration can progress. # Output only. Snapshot of the parent pipeline taken at release creation time.
"annotations": { # User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy.
"a_key": "A String",
@@ -463,7 +554,7 @@ Method Details
"status": True or False, # True if the Pipeline is in a valid state. Otherwise at least one condition in `PipelineCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.
"updateTime": "A String", # Last time the condition was updated.
},
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -541,6 +632,15 @@ Method Details
"runtimeConfig": { # RuntimeConfig contains the runtime specific configurations for a deployment strategy. # Optional. Runtime specific configurations for the deployment strategy. The runtime configuration is used to determine how Cloud Deploy will split traffic to enable a progressive deployment.
"cloudRun": { # CloudRunConfig contains the Cloud Run runtime configuration. # Cloud Run runtime configuration.
"automaticTrafficControl": True or False, # Whether Cloud Deploy should update the traffic stanza in a Cloud Run Service on the user's behalf to facilitate traffic splitting. This is required to be true for CanaryDeployments, but optional for CustomCanaryDeployments.
+ "canaryRevisionTags": [ # Optional. A list of tags that are added to the canary revision while the canary deployment is in progress.
+ "A String",
+ ],
+ "priorRevisionTags": [ # Optional. A list of tags that are added to the prior revision while the canary deployment is in progress.
+ "A String",
+ ],
+ "stableRevisionTags": [ # Optional. A list of tags that are added to the final stable revision after the canary deployment is completed.
+ "A String",
+ ],
},
"kubernetes": { # KubernetesConfig contains the Kubernetes runtime configuration. # Kubernetes runtime configuration.
"gatewayServiceMesh": { # Information about the Kubernetes Gateway API service mesh configuration. # Kubernetes Gateway API service mesh configuration.
@@ -616,6 +716,11 @@ Method Details
"cloudRun": { # CloudRunRenderMetadata contains Cloud Run information associated with a `Release` render. # Output only. Metadata associated with rendering for Cloud Run.
"service": "A String", # Output only. The name of the Cloud Run Service in the rendered manifest. Format is `projects/{project}/locations/{location}/services/{service}`.
},
+ "custom": { # CustomMetadata contains information from a user defined operation. # Output only. Custom metadata provided by user defined render operation.
+ "values": { # Output only. Key-value pairs provided by the user defined operation.
+ "a_key": "A String",
+ },
+ },
},
"renderingBuild": "A String", # Output only. The resource name of the Cloud Build `Build` object that is used to render the manifest for this target. Format is `projects/{project}/locations/{location}/builds/{build}`.
"renderingState": "A String", # Output only. Current state of the render operation for this Target.
@@ -630,6 +735,9 @@ Method Details
"membership": "A String", # Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`.
},
"createTime": "A String", # Output only. Time at which the `Target` was created.
+ "customTarget": { # Information specifying a Custom Target. # Optional. Information specifying a Custom Target.
+ "customTargetType": "A String", # Required. The name of the CustomTargetType. Format must be `projects/{project}/locations/{location}/customTargetTypes/{custom_target_type}`.
+ },
"deployParameters": { # Optional. The deploy parameters to use for this target.
"a_key": "A String",
},
@@ -717,14 +825,51 @@ Method Details
"releaseReadyCondition": { # ReleaseReadyCondition contains information around the status of the Release. If a release is not ready, you cannot create a rollout with the release. # Details around the Releases's overall status.
"status": True or False, # True if the Release is in a valid state. Otherwise at least one condition in `ReleaseCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Release.
},
- "skaffoldSupportedCondition": { # SkaffoldSupportedCondition contains information about when support for the release's version of skaffold ends. # Details around the support state of the release's skaffold version.
- "maintenanceModeTime": "A String", # The time at which this release's version of skaffold will enter maintenance mode.
- "skaffoldSupportState": "A String", # The skaffold support state for this release's version of skaffold.
- "status": True or False, # True if the version of skaffold used by this release is supported.
- "supportExpirationTime": "A String", # The time at which this release's version of skaffold will no longer be supported.
+ "skaffoldSupportedCondition": { # SkaffoldSupportedCondition contains information about when support for the release's version of Skaffold ends. # Details around the support state of the release's Skaffold version.
+ "maintenanceModeTime": "A String", # The time at which this release's version of Skaffold will enter maintenance mode.
+ "skaffoldSupportState": "A String", # The Skaffold support state for this release's version of Skaffold.
+ "status": True or False, # True if the version of Skaffold used by this release is supported.
+ "supportExpirationTime": "A String", # The time at which this release's version of Skaffold will no longer be supported.
},
},
"createTime": "A String", # Output only. Time at which the `Release` was created.
+ "customTargetTypeSnapshots": [ # Output only. Snapshot of the custom target types referenced by the targets taken at release creation time.
+ { # A `CustomTargetType` resource in the Cloud Deploy API. A `CustomTargetType` defines a type of custom target that can be referenced in a `Target` in order to facilitate deploying to a runtime that does not have a 1P integration with Cloud Deploy.
+ "annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
+ "a_key": "A String",
+ },
+ "createTime": "A String", # Output only. Time at which the `CustomTargetType` was created.
+ "customActions": { # CustomTargetSkaffoldActions represents the `CustomTargetType` configuration using Skaffold custom actions. # Configures render and deploy for the `CustomTargetType` using Skaffold custom actions.
+ "deployAction": "A String", # Required. The Skaffold custom action responsible for deploy operations.
+ "includeSkaffoldModules": [ # Optional. List of Skaffold modules Cloud Deploy will include in the Skaffold Config as required before performing diagnose.
+ { # Skaffold Config modules and their remote source.
+ "configs": [ # Optional. The Skaffold Config modules to use from the specified source.
+ "A String",
+ ],
+ "git": { # Git repository containing Skaffold Config modules. # Remote git repository containing the Skaffold Config modules.
+ "path": "A String", # Optional. Relative path from the repository root to the Skaffold file.
+ "ref": "A String", # Optional. Git ref the package should be cloned from.
+ "repo": "A String", # Required. Git repository the package should be cloned from.
+ },
+ "googleCloudStorage": { # Cloud Storage bucket containing Skaffold Config modules. # Cloud Storage bucket containing the Skaffold Config modules.
+ "path": "A String", # Optional. Relative path from the source to the Skaffold file.
+ "source": "A String", # Required. Cloud Storage source paths to copy recursively. For example, providing "gs://my-bucket/dir/configs/*" will result in Skaffold copying all files within the "dir/configs" directory in the bucket "my-bucket".
+ },
+ },
+ ],
+ "renderAction": "A String", # Optional. The Skaffold custom action responsible for render operations. If not provided then Cloud Deploy will perform the render operations via `skaffold render`.
+ },
+ "customTargetTypeId": "A String", # Output only. Resource id of the `CustomTargetType`.
+ "description": "A String", # Optional. Description of the `CustomTargetType`. Max length is 255 characters.
+ "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
+ "a_key": "A String",
+ },
+ "name": "A String", # Optional. Name of the `CustomTargetType`. Format is `projects/{project}/locations/{location}/customTargetTypes/a-z{0,62}`.
+ "uid": "A String", # Output only. Unique identifier of the `CustomTargetType`.
+ "updateTime": "A String", # Output only. Most recent time at which the `CustomTargetType` was updated.
+ },
+ ],
"deliveryPipelineSnapshot": { # A `DeliveryPipeline` resource in the Cloud Deploy API. A `DeliveryPipeline` defines a pipeline through which a Skaffold configuration can progress. # Output only. Snapshot of the parent pipeline taken at release creation time.
"annotations": { # User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy.
"a_key": "A String",
@@ -734,7 +879,7 @@ Method Details
"status": True or False, # True if the Pipeline is in a valid state. Otherwise at least one condition in `PipelineCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.
"updateTime": "A String", # Last time the condition was updated.
},
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -812,6 +957,15 @@ Method Details
"runtimeConfig": { # RuntimeConfig contains the runtime specific configurations for a deployment strategy. # Optional. Runtime specific configurations for the deployment strategy. The runtime configuration is used to determine how Cloud Deploy will split traffic to enable a progressive deployment.
"cloudRun": { # CloudRunConfig contains the Cloud Run runtime configuration. # Cloud Run runtime configuration.
"automaticTrafficControl": True or False, # Whether Cloud Deploy should update the traffic stanza in a Cloud Run Service on the user's behalf to facilitate traffic splitting. This is required to be true for CanaryDeployments, but optional for CustomCanaryDeployments.
+ "canaryRevisionTags": [ # Optional. A list of tags that are added to the canary revision while the canary deployment is in progress.
+ "A String",
+ ],
+ "priorRevisionTags": [ # Optional. A list of tags that are added to the prior revision while the canary deployment is in progress.
+ "A String",
+ ],
+ "stableRevisionTags": [ # Optional. A list of tags that are added to the final stable revision after the canary deployment is completed.
+ "A String",
+ ],
},
"kubernetes": { # KubernetesConfig contains the Kubernetes runtime configuration. # Kubernetes runtime configuration.
"gatewayServiceMesh": { # Information about the Kubernetes Gateway API service mesh configuration. # Kubernetes Gateway API service mesh configuration.
@@ -887,6 +1041,11 @@ Method Details
"cloudRun": { # CloudRunRenderMetadata contains Cloud Run information associated with a `Release` render. # Output only. Metadata associated with rendering for Cloud Run.
"service": "A String", # Output only. The name of the Cloud Run Service in the rendered manifest. Format is `projects/{project}/locations/{location}/services/{service}`.
},
+ "custom": { # CustomMetadata contains information from a user defined operation. # Output only. Custom metadata provided by user defined render operation.
+ "values": { # Output only. Key-value pairs provided by the user defined operation.
+ "a_key": "A String",
+ },
+ },
},
"renderingBuild": "A String", # Output only. The resource name of the Cloud Build `Build` object that is used to render the manifest for this target. Format is `projects/{project}/locations/{location}/builds/{build}`.
"renderingState": "A String", # Output only. Current state of the render operation for this Target.
@@ -901,6 +1060,9 @@ Method Details
"membership": "A String", # Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`.
},
"createTime": "A String", # Output only. Time at which the `Target` was created.
+ "customTarget": { # Information specifying a Custom Target. # Optional. Information specifying a Custom Target.
+ "customTargetType": "A String", # Required. The name of the CustomTargetType. Format must be `projects/{project}/locations/{location}/customTargetTypes/{custom_target_type}`.
+ },
"deployParameters": { # Optional. The deploy parameters to use for this target.
"a_key": "A String",
},
diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html
index ca0d0ebc324..4d90d364ea1 100644
--- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html
+++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html
@@ -235,6 +235,11 @@ Method Details
"A String",
],
},
+ "custom": { # CustomMetadata contains information from a user defined operation. # Output only. Custom metadata provided by user defined `Rollout` operations.
+ "values": { # Output only. Key-value pairs provided by the user defined operation.
+ "a_key": "A String",
+ },
+ },
},
"name": "A String", # Optional. Name of the `Rollout`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}`.
"phases": [ # Output only. The phases that represent the workflows of this `Rollout`.
@@ -489,6 +494,11 @@ Method Details
"A String",
],
},
+ "custom": { # CustomMetadata contains information from a user defined operation. # Output only. Custom metadata provided by user defined `Rollout` operations.
+ "values": { # Output only. Key-value pairs provided by the user defined operation.
+ "a_key": "A String",
+ },
+ },
},
"name": "A String", # Optional. Name of the `Rollout`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}`.
"phases": [ # Output only. The phases that represent the workflows of this `Rollout`.
@@ -744,6 +754,11 @@ Method Details
"A String",
],
},
+ "custom": { # CustomMetadata contains information from a user defined operation. # Output only. Custom metadata provided by user defined `Rollout` operations.
+ "values": { # Output only. Key-value pairs provided by the user defined operation.
+ "a_key": "A String",
+ },
+ },
},
"name": "A String", # Optional. Name of the `Rollout`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}`.
"phases": [ # Output only. The phases that represent the workflows of this `Rollout`.
diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.html
index 64cb0d9b3c2..f09b89bc9c6 100644
--- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.html
+++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.html
@@ -138,6 +138,14 @@ Method Details
"A String",
],
},
+ "custom": { # CustomMetadata contains information from a user defined operation. # Output only. Custom metadata provided by user defined deploy operation.
+ "values": { # Output only. Key-value pairs provided by the user defined operation.
+ "a_key": "A String",
+ },
+ },
+ "customTarget": { # CustomTargetDeployMetadata contains information from a Custom Target deploy operation. # Output only. Custom Target metadata associated with a `DeployJobRun`.
+ "skipMessage": "A String", # Output only. Skip message provided in the results of a custom deploy operation.
+ },
},
},
"endTime": "A String", # Output only. Time at which the `JobRun` ended.
@@ -217,6 +225,14 @@ Method Details
"A String",
],
},
+ "custom": { # CustomMetadata contains information from a user defined operation. # Output only. Custom metadata provided by user defined deploy operation.
+ "values": { # Output only. Key-value pairs provided by the user defined operation.
+ "a_key": "A String",
+ },
+ },
+ "customTarget": { # CustomTargetDeployMetadata contains information from a Custom Target deploy operation. # Output only. Custom Target metadata associated with a `DeployJobRun`.
+ "skipMessage": "A String", # Output only. Skip message provided in the results of a custom deploy operation.
+ },
},
},
"endTime": "A String", # Output only. Time at which the `JobRun` ended.
diff --git a/docs/dyn/clouddeploy_v1.projects.locations.html b/docs/dyn/clouddeploy_v1.projects.locations.html
index 8d8dab1929d..5845e9ea782 100644
--- a/docs/dyn/clouddeploy_v1.projects.locations.html
+++ b/docs/dyn/clouddeploy_v1.projects.locations.html
@@ -74,6 +74,11 @@
Cloud Deploy API . projects . locations
Instance Methods
+
+Returns the customTargetTypes Resource.
+
@@ -156,13 +161,13 @@ Method Details
"name": "A String", # Name of the configuration.
"supportedVersions": [ # All supported versions of Skaffold.
{ # Details of a supported Skaffold version.
- "maintenanceModeTime": "A String", # The time at which this version of skaffold will enter maintenance mode.
+ "maintenanceModeTime": "A String", # The time at which this version of Skaffold will enter maintenance mode.
"supportEndDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date when this version is expected to no longer be supported.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
- "supportExpirationTime": "A String", # The time at which this version of skaffold will no longer be supported.
+ "supportExpirationTime": "A String", # The time at which this version of Skaffold will no longer be supported.
"version": "A String", # Release version number. For example, "1.20.3".
},
],
diff --git a/docs/dyn/clouddeploy_v1.projects.locations.targets.html b/docs/dyn/clouddeploy_v1.projects.locations.targets.html
index 1d259220115..a08ad068547 100644
--- a/docs/dyn/clouddeploy_v1.projects.locations.targets.html
+++ b/docs/dyn/clouddeploy_v1.projects.locations.targets.html
@@ -127,6 +127,9 @@ Method Details
"membership": "A String", # Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`.
},
"createTime": "A String", # Output only. Time at which the `Target` was created.
+ "customTarget": { # Information specifying a Custom Target. # Optional. Information specifying a Custom Target.
+ "customTargetType": "A String", # Required. The name of the CustomTargetType. Format must be `projects/{project}/locations/{location}/customTargetTypes/{custom_target_type}`.
+ },
"deployParameters": { # Optional. The deploy parameters to use for this target.
"a_key": "A String",
},
@@ -267,6 +270,9 @@ Method Details
"membership": "A String", # Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`.
},
"createTime": "A String", # Output only. Time at which the `Target` was created.
+ "customTarget": { # Information specifying a Custom Target. # Optional. Information specifying a Custom Target.
+ "customTargetType": "A String", # Required. The name of the CustomTargetType. Format must be `projects/{project}/locations/{location}/customTargetTypes/{custom_target_type}`.
+ },
"deployParameters": { # Optional. The deploy parameters to use for this target.
"a_key": "A String",
},
@@ -392,6 +398,9 @@ Method Details
"membership": "A String", # Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`.
},
"createTime": "A String", # Output only. Time at which the `Target` was created.
+ "customTarget": { # Information specifying a Custom Target. # Optional. Information specifying a Custom Target.
+ "customTargetType": "A String", # Required. The name of the CustomTargetType. Format must be `projects/{project}/locations/{location}/customTargetTypes/{custom_target_type}`.
+ },
"deployParameters": { # Optional. The deploy parameters to use for this target.
"a_key": "A String",
},
@@ -476,6 +485,9 @@ Method Details
"membership": "A String", # Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`.
},
"createTime": "A String", # Output only. Time at which the `Target` was created.
+ "customTarget": { # Information specifying a Custom Target. # Optional. Information specifying a Custom Target.
+ "customTargetType": "A String", # Required. The name of the CustomTargetType. Format must be `projects/{project}/locations/{location}/customTargetTypes/{custom_target_type}`.
+ },
"deployParameters": { # Optional. The deploy parameters to use for this target.
"a_key": "A String",
},
diff --git a/docs/dyn/cloudscheduler_v1.projects.locations.jobs.html b/docs/dyn/cloudscheduler_v1.projects.locations.jobs.html
index 8ea2535d8d8..85b7f327bc3 100644
--- a/docs/dyn/cloudscheduler_v1.projects.locations.jobs.html
+++ b/docs/dyn/cloudscheduler_v1.projects.locations.jobs.html
@@ -128,7 +128,7 @@ Method Details
"version": "A String", # App version. By default, the job is sent to the version which is the default version when the job is attempted.
},
"body": "A String", # Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
+ "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
"a_key": "A String",
},
"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
@@ -138,7 +138,7 @@ Method Details
"description": "A String", # Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
"httpTarget": { # Http target. The job will be pushed to the job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. A failure to receive a response constitutes a failed execution. For a redirected request, the response returned by the redirected request is considered. # HTTP target.
"body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
+ "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
"a_key": "A String",
},
"httpMethod": "A String", # Which HTTP method to use for the request.
@@ -201,7 +201,7 @@ Method Details
"version": "A String", # App version. By default, the job is sent to the version which is the default version when the job is attempted.
},
"body": "A String", # Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
+ "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
"a_key": "A String",
},
"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
@@ -211,7 +211,7 @@ Method Details
"description": "A String", # Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
"httpTarget": { # Http target. The job will be pushed to the job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. A failure to receive a response constitutes a failed execution. For a redirected request, the response returned by the redirected request is considered. # HTTP target.
"body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
+ "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
"a_key": "A String",
},
"httpMethod": "A String", # Which HTTP method to use for the request.
@@ -299,7 +299,7 @@ Method Details
"version": "A String", # App version. By default, the job is sent to the version which is the default version when the job is attempted.
},
"body": "A String", # Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
+ "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
"a_key": "A String",
},
"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
@@ -309,7 +309,7 @@ Method Details
"description": "A String", # Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
"httpTarget": { # Http target. The job will be pushed to the job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. A failure to receive a response constitutes a failed execution. For a redirected request, the response returned by the redirected request is considered. # HTTP target.
"body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
+ "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
"a_key": "A String",
},
"httpMethod": "A String", # Which HTTP method to use for the request.
@@ -383,7 +383,7 @@ Method Details
"version": "A String", # App version. By default, the job is sent to the version which is the default version when the job is attempted.
},
"body": "A String", # Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
+ "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
"a_key": "A String",
},
"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
@@ -393,7 +393,7 @@ Method Details
"description": "A String", # Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
"httpTarget": { # Http target. The job will be pushed to the job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. A failure to receive a response constitutes a failed execution. For a redirected request, the response returned by the redirected request is considered. # HTTP target.
"body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
+ "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
"a_key": "A String",
},
"httpMethod": "A String", # Which HTTP method to use for the request.
@@ -475,7 +475,7 @@ Method Details
"version": "A String", # App version. By default, the job is sent to the version which is the default version when the job is attempted.
},
"body": "A String", # Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
+ "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
"a_key": "A String",
},
"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
@@ -485,7 +485,7 @@ Method Details
"description": "A String", # Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
"httpTarget": { # Http target. The job will be pushed to the job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. A failure to receive a response constitutes a failed execution. For a redirected request, the response returned by the redirected request is considered. # HTTP target.
"body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
+ "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
"a_key": "A String",
},
"httpMethod": "A String", # Which HTTP method to use for the request.
@@ -549,7 +549,7 @@ Method Details
"version": "A String", # App version. By default, the job is sent to the version which is the default version when the job is attempted.
},
"body": "A String", # Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
+ "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
"a_key": "A String",
},
"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
@@ -559,7 +559,7 @@ Method Details
"description": "A String", # Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
"httpTarget": { # Http target. The job will be pushed to the job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. A failure to receive a response constitutes a failed execution. For a redirected request, the response returned by the redirected request is considered. # HTTP target.
"body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
+ "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
"a_key": "A String",
},
"httpMethod": "A String", # Which HTTP method to use for the request.
@@ -635,7 +635,7 @@ Method Details
"version": "A String", # App version. By default, the job is sent to the version which is the default version when the job is attempted.
},
"body": "A String", # Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
+ "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
"a_key": "A String",
},
"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
@@ -645,7 +645,7 @@ Method Details
"description": "A String", # Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
"httpTarget": { # Http target. The job will be pushed to the job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. A failure to receive a response constitutes a failed execution. For a redirected request, the response returned by the redirected request is considered. # HTTP target.
"body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
+ "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
"a_key": "A String",
},
"httpMethod": "A String", # Which HTTP method to use for the request.
@@ -721,7 +721,7 @@ Method Details
"version": "A String", # App version. By default, the job is sent to the version which is the default version when the job is attempted.
},
"body": "A String", # Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
+ "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
"a_key": "A String",
},
"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
@@ -731,7 +731,7 @@ Method Details
"description": "A String", # Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
"httpTarget": { # Http target. The job will be pushed to the job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. A failure to receive a response constitutes a failed execution. For a redirected request, the response returned by the redirected request is considered. # HTTP target.
"body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
+ "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
"a_key": "A String",
},
"httpMethod": "A String", # Which HTTP method to use for the request.
@@ -807,7 +807,7 @@ Method Details
"version": "A String", # App version. By default, the job is sent to the version which is the default version when the job is attempted.
},
"body": "A String", # Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
+ "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
"a_key": "A String",
},
"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
@@ -817,7 +817,7 @@ Method Details
"description": "A String", # Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
"httpTarget": { # Http target. The job will be pushed to the job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. A failure to receive a response constitutes a failed execution. For a redirected request, the response returned by the redirected request is considered. # HTTP target.
"body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
+ "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
"a_key": "A String",
},
"httpMethod": "A String", # Which HTTP method to use for the request.
diff --git a/docs/dyn/cloudscheduler_v1beta1.projects.locations.jobs.html b/docs/dyn/cloudscheduler_v1beta1.projects.locations.jobs.html
index 677c3058b0e..23966be2743 100644
--- a/docs/dyn/cloudscheduler_v1beta1.projects.locations.jobs.html
+++ b/docs/dyn/cloudscheduler_v1beta1.projects.locations.jobs.html
@@ -128,7 +128,7 @@ Method Details
"version": "A String", # App version. By default, the job is sent to the version which is the default version when the job is attempted.
},
"body": "A String", # Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
+ "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
"a_key": "A String",
},
"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
@@ -138,7 +138,7 @@ Method Details
"description": "A String", # Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
"httpTarget": { # Http target. The job will be pushed to the job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. A failure to receive a response constitutes a failed execution. For a redirected request, the response returned by the redirected request is considered. # HTTP target.
"body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
+ "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
"a_key": "A String",
},
"httpMethod": "A String", # Which HTTP method to use for the request.
@@ -202,7 +202,7 @@ Method Details
"version": "A String", # App version. By default, the job is sent to the version which is the default version when the job is attempted.
},
"body": "A String", # Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
+ "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
"a_key": "A String",
},
"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
@@ -212,7 +212,7 @@ Method Details
"description": "A String", # Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
"httpTarget": { # Http target. The job will be pushed to the job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. A failure to receive a response constitutes a failed execution. For a redirected request, the response returned by the redirected request is considered. # HTTP target.
"body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
+ "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
"a_key": "A String",
},
"httpMethod": "A String", # Which HTTP method to use for the request.
@@ -302,7 +302,7 @@ Method Details
"version": "A String", # App version. By default, the job is sent to the version which is the default version when the job is attempted.
},
"body": "A String", # Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
+ "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
"a_key": "A String",
},
"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
@@ -312,7 +312,7 @@ Method Details
"description": "A String", # Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
"httpTarget": { # Http target. The job will be pushed to the job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. A failure to receive a response constitutes a failed execution. For a redirected request, the response returned by the redirected request is considered. # HTTP target.
"body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
+ "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
"a_key": "A String",
},
"httpMethod": "A String", # Which HTTP method to use for the request.
@@ -389,7 +389,7 @@ Method Details
"version": "A String", # App version. By default, the job is sent to the version which is the default version when the job is attempted.
},
"body": "A String", # Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
+ "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
"a_key": "A String",
},
"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
@@ -399,7 +399,7 @@ Method Details
"description": "A String", # Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
"httpTarget": { # Http target. The job will be pushed to the job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. A failure to receive a response constitutes a failed execution. For a redirected request, the response returned by the redirected request is considered. # HTTP target.
"body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
+ "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
"a_key": "A String",
},
"httpMethod": "A String", # Which HTTP method to use for the request.
@@ -482,7 +482,7 @@ Method Details
"version": "A String", # App version. By default, the job is sent to the version which is the default version when the job is attempted.
},
"body": "A String", # Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
+ "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
"a_key": "A String",
},
"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
@@ -492,7 +492,7 @@ Method Details
"description": "A String", # Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
"httpTarget": { # Http target. The job will be pushed to the job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. A failure to receive a response constitutes a failed execution. For a redirected request, the response returned by the redirected request is considered. # HTTP target.
"body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
+ "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
"a_key": "A String",
},
"httpMethod": "A String", # Which HTTP method to use for the request.
@@ -557,7 +557,7 @@ Method Details
"version": "A String", # App version. By default, the job is sent to the version which is the default version when the job is attempted.
},
"body": "A String", # Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
+ "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
"a_key": "A String",
},
"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
@@ -567,7 +567,7 @@ Method Details
"description": "A String", # Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
"httpTarget": { # Http target. The job will be pushed to the job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. A failure to receive a response constitutes a failed execution. For a redirected request, the response returned by the redirected request is considered. # HTTP target.
"body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
+ "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
"a_key": "A String",
},
"httpMethod": "A String", # Which HTTP method to use for the request.
@@ -644,7 +644,7 @@ Method Details
"version": "A String", # App version. By default, the job is sent to the version which is the default version when the job is attempted.
},
"body": "A String", # Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
+ "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
"a_key": "A String",
},
"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
@@ -654,7 +654,7 @@ Method Details
"description": "A String", # Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
"httpTarget": { # Http target. The job will be pushed to the job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. A failure to receive a response constitutes a failed execution. For a redirected request, the response returned by the redirected request is considered. # HTTP target.
"body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
+ "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
"a_key": "A String",
},
"httpMethod": "A String", # Which HTTP method to use for the request.
@@ -731,7 +731,7 @@ Method Details
"version": "A String", # App version. By default, the job is sent to the version which is the default version when the job is attempted.
},
"body": "A String", # Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
+ "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
"a_key": "A String",
},
"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
@@ -741,7 +741,7 @@ Method Details
"description": "A String", # Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
"httpTarget": { # Http target. The job will be pushed to the job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. A failure to receive a response constitutes a failed execution. For a redirected request, the response returned by the redirected request is considered. # HTTP target.
"body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
+ "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
"a_key": "A String",
},
"httpMethod": "A String", # Which HTTP method to use for the request.
@@ -819,7 +819,7 @@ Method Details
"version": "A String", # App version. By default, the job is sent to the version which is the default version when the job is attempted.
},
"body": "A String", # Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
+ "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
"a_key": "A String",
},
"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
@@ -829,7 +829,7 @@ Method Details
"description": "A String", # Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
"httpTarget": { # Http target. The job will be pushed to the job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. A failure to receive a response constitutes a failed execution. For a redirected request, the response returned by the redirected request is considered. # HTTP target.
"body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
- "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
+ "headers": { # HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB.
"a_key": "A String",
},
"httpMethod": "A String", # Which HTTP method to use for the request.
diff --git a/docs/dyn/cloudtasks_v2.projects.locations.queues.tasks.html b/docs/dyn/cloudtasks_v2.projects.locations.queues.tasks.html
index 6ae8a5ad033..448d13f7b9b 100644
--- a/docs/dyn/cloudtasks_v2.projects.locations.queues.tasks.html
+++ b/docs/dyn/cloudtasks_v2.projects.locations.queues.tasks.html
@@ -216,7 +216,7 @@ Method Details
{ # Request message for CreateTask.
"responseView": "A String", # The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource.
- "task": { # A unit of scheduled work. # Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. If the task's queue was created using Cloud Tasks, then another task with the same name can't be created for ~1hour after the original task was deleted or executed. If the task's queue was created using queue.yaml or queue.xml, then another task with the same name can't be created for ~9days after the original task was deleted or executed. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently.
+ "task": { # A unit of scheduled work. # Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 4 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently.
"appEngineHttpRequest": { # App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. Using AppEngineHttpRequest requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If app_engine_routing_override is set on the queue, this value is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is: * `url =` host `+` relative_uri Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the deadline. Failed tasks will be retried according to the retry configuration. `503` (Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a `429` (Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue. # HTTP request that is sent to the App Engine app handler. An App Engine task is a task that has AppEngineHttpRequest set.
"appEngineRouting": { # App Engine Routing. Defines routing characteristics specific to App Engine - service, version, and instance. For more information about services, versions, and instances see [An Overview of App Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), [Microservices Architecture on Google App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). Using AppEngineRouting requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` # Task-level setting for App Engine routing. * If app_engine_routing_override is set on the queue, this value is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.
"host": "A String", # Output only. The host that the task is sent to. The host is constructed from the domain name of the app associated with the queue's project ID (for example .appspot.com), and the service, version, and instance. Tasks which were created using the App Engine SDK might have a custom domain name. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
diff --git a/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.tasks.html b/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.tasks.html
index 26ccc9ddb32..24513166484 100644
--- a/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.tasks.html
+++ b/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.tasks.html
@@ -354,7 +354,7 @@ Method Details
{ # Request message for CreateTask.
"responseView": "A String", # The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource.
- "task": { # A unit of scheduled work. # Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or completed recently then the call will fail with ALREADY_EXISTS. If the task's queue was created using Cloud Tasks, then another task with the same name can't be created for ~1 hour after the original task was deleted or completed. If the task's queue was created using queue.yaml or queue.xml, then another task with the same name can't be created for ~9 days after the original task was deleted or completed. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently.
+ "task": { # A unit of scheduled work. # Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or completed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 4 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently.
"appEngineHttpRequest": { # App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. This proto can only be used for tasks in a queue which has app_engine_http_target set. Using AppEngineHttpRequest requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is: * `url =` host `+` relative_url Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the deadline. Failed tasks will be retried according to the retry configuration. `503` (Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a `429` (Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue. # App Engine HTTP request that is sent to the task's target. Can be set only if app_engine_http_target is set on the queue. An App Engine task is a task that has AppEngineHttpRequest set.
"appEngineRouting": { # App Engine Routing. Defines routing characteristics specific to App Engine - service, version, and instance. For more information about services, versions, and instances see [An Overview of App Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), [Microservices Architecture on Google App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). # Task-level setting for App Engine routing. If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.
"host": "A String", # Output only. The host that the task is sent to. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). The host is constructed as: * `host = [application_domain_name]` `| [service] + '.' + [application_domain_name]` `| [version] + '.' + [application_domain_name]` `| [version_dot_service]+ '.' + [application_domain_name]` `| [instance] + '.' + [application_domain_name]` `| [instance_dot_service] + '.' + [application_domain_name]` `| [instance_dot_version] + '.' + [application_domain_name]` `| [instance_dot_version_dot_service] + '.' + [application_domain_name]` * `application_domain_name` = The domain name of the app, for example .appspot.com, which is associated with the queue's project ID. Some tasks which were created using the App Engine SDK use a custom domain name. * `service =` service * `version =` version * `version_dot_service =` version `+ '.' +` service * `instance =` instance * `instance_dot_service =` instance `+ '.' +` service * `instance_dot_version =` instance `+ '.' +` version * `instance_dot_version_dot_service =` instance `+ '.' +` version `+ '.' +` service If service is empty, then the task will be sent to the service which is the default service when the task is attempted. If version is empty, then the task will be sent to the version which is the default version when the task is attempted. If instance is empty, then the task will be sent to an instance which is available when the task is attempted. If service, version, or instance is invalid, then the task will be sent to the default version of the default service when the task is attempted.
diff --git a/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.tasks.html b/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.tasks.html
index f465c41b0bd..c9f8de275ce 100644
--- a/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.tasks.html
+++ b/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.tasks.html
@@ -220,7 +220,7 @@ Method Details
{ # Request message for CreateTask.
"responseView": "A String", # The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource.
- "task": { # A unit of scheduled work. # Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. If the task's queue was created using Cloud Tasks, then another task with the same name can't be created for ~1 hour after the original task was deleted or executed. If the task's queue was created using queue.yaml or queue.xml, then another task with the same name can't be created for ~9 days after the original task was deleted or executed. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently.
+ "task": { # A unit of scheduled work. # Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 4 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently.
"appEngineHttpRequest": { # App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. Using AppEngineHttpRequest requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is: * `url =` host `+` relative_uri Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the deadline. Failed tasks will be retried according to the retry configuration. `503` (Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a `429` (Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue. # HTTP request that is sent to the App Engine app handler. An App Engine task is a task that has AppEngineHttpRequest set.
"appEngineRouting": { # App Engine Routing. Defines routing characteristics specific to App Engine - service, version, and instance. For more information about services, versions, and instances see [An Overview of App Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), [Microservices Architecture on Google App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). # Task-level setting for App Engine routing. If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.
"host": "A String", # Output only. The host that the task is sent to. The host is constructed from the domain name of the app associated with the queue's project ID (for example .appspot.com), and the service, version, and instance. Tasks which were created using the App Engine SDK might have a custom domain name. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
diff --git a/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html b/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html
index 55fbb3ce13b..2d1c7f6d413 100644
--- a/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html
+++ b/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html
@@ -111,7 +111,7 @@ Method Details
The object takes the form of:
{ # CustomConnectorVersion indicates a specific version of a connector.
- "authConfig": { # AuthConfig defines details of a authentication type. # Required. Configuration for establishing the authentication to the connector destination.
+ "authConfig": { # AuthConfig defines details of a authentication type. # Optional. Authentication config for accessing connector facade/ proxy. This is used only when enable_backend_destination_config is true.
"additionalVariables": [ # List containing additional auth configs.
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
"boolValue": True or False, # Value is a bool.
@@ -176,23 +176,78 @@ Method Details
"username": "A String", # Username.
},
},
- "createTime": "A String", # Output only. Created time.
- "destinationConfig": { # Define the Connectors target endpoint. # Required. Configuration of the customConnector's destination.
- "destinations": [ # The destinations for the key.
- {
- "host": "A String", # For publicly routable host.
- "port": 42, # The port is the target port number that is accepted by the destination.
- "serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
+ "backendVariableTemplates": [ # Optional. Backend variables config templates. This translates to additional variable templates in connection.
+ { # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection.
+ "authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE`
+ "clientId": "A String", # The client ID assigned to the Google Cloud Connectors OAuth app for the connector data source.
+ "enablePkce": True or False, # Whether to enable PKCE for the auth code flow.
+ "scopes": [ # The scopes for which the user will authorize Google Cloud Connectors on the connector data source.
+ "A String",
+ ],
+ "uri": "A String", # The base URI the user must click to trigger the authorization code login flow.
+ },
+ "description": "A String", # Description.
+ "displayName": "A String", # Display name of the parameter.
+ "enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM`
+ { # EnumOption definition
+ "displayName": "A String", # Display name of the option.
+ "id": "A String", # Id of the option.
+ },
+ ],
+ "isAdvanced": True or False, # Indicates if current template is part of advanced settings
+ "key": "A String", # Key of the config variable.
+ "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
+ "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
+ "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
+ "fieldComparisons": [ # A list of fields to be compared.
+ { # Field that needs to be compared.
+ "boolValue": True or False, # Boolean value
+ "comparator": "A String", # Comparator to use for comparing the field value.
+ "intValue": "A String", # Integer value
+ "key": "A String", # Key of the field.
+ "stringValue": "A String", # String value
+ },
+ ],
+ "logicalExpressions": [ # A list of nested conditions to be compared.
+ # Object with schema name: LogicalExpression
+ ],
+ "logicalOperator": "A String", # The logical operator to use between the fields and conditions.
+ },
+ "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Role grant configuration for the config variable.
+ "helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers.
+ "principal": "A String", # Prinicipal/Identity for whom the role need to assigned.
+ "resource": { # Resource definition # Resource on which the roles needs to be granted for the principal.
+ "pathTemplate": "A String", # Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template.
+ "type": "A String", # Different types of resource supported.
+ },
+ "roles": [ # List of roles that need to be granted.
+ "A String",
+ ],
},
- ],
- "key": "A String", # The key is the destination identifier that is supported by the Connector.
- },
- "enableBackendDestinationConfig": True or False, # Optional. Whether to enable backend destination config. This is the backend server that the connector connects to.
+ "state": "A String", # State of the config variable.
+ "validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
+ "valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.
+ },
+ ],
+ "createTime": "A String", # Output only. Created time.
+ "destinationConfigs": [ # Optional. Destination config(s) for accessing connector facade/ proxy. This is used only when enable_backend_destination_config is true.
+ { # Define the Connectors target endpoint.
+ "destinations": [ # The destinations for the key.
+ {
+ "host": "A String", # For publicly routable host.
+ "port": 42, # The port is the target port number that is accepted by the destination.
+ "serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
+ },
+ ],
+ "key": "A String", # The key is the destination identifier that is supported by the Connector.
+ },
+ ],
+ "enableBackendDestinationConfig": True or False, # Optional. When enabled, the connector will be a facade/ proxy, and connects to the destination provided during connection creation.
"labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
"a_key": "A String",
},
"name": "A String", # Output only. Identifier. Resource name of the Version. Format: projects/{project}/locations/{location}/customConnectors/{custom_connector}/customConnectorVersions/{custom_connector_version}
- "serviceAccount": "A String", # Required. Service account needed for runtime plane to access Custom Connector secrets.
+ "serviceAccount": "A String", # Required. Service account used by runtime plane to access auth config secrets.
"specLocation": "A String", # Optional. Location of the custom connector spec.
"updateTime": "A String", # Output only. Updated time.
}
@@ -277,7 +332,7 @@ Method Details
An object of the form:
{ # CustomConnectorVersion indicates a specific version of a connector.
- "authConfig": { # AuthConfig defines details of a authentication type. # Required. Configuration for establishing the authentication to the connector destination.
+ "authConfig": { # AuthConfig defines details of a authentication type. # Optional. Authentication config for accessing connector facade/ proxy. This is used only when enable_backend_destination_config is true.
"additionalVariables": [ # List containing additional auth configs.
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
"boolValue": True or False, # Value is a bool.
@@ -342,23 +397,78 @@ Method Details
"username": "A String", # Username.
},
},
- "createTime": "A String", # Output only. Created time.
- "destinationConfig": { # Define the Connectors target endpoint. # Required. Configuration of the customConnector's destination.
- "destinations": [ # The destinations for the key.
- {
- "host": "A String", # For publicly routable host.
- "port": 42, # The port is the target port number that is accepted by the destination.
- "serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
+ "backendVariableTemplates": [ # Optional. Backend variables config templates. This translates to additional variable templates in connection.
+ { # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection.
+ "authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE`
+ "clientId": "A String", # The client ID assigned to the Google Cloud Connectors OAuth app for the connector data source.
+ "enablePkce": True or False, # Whether to enable PKCE for the auth code flow.
+ "scopes": [ # The scopes for which the user will authorize Google Cloud Connectors on the connector data source.
+ "A String",
+ ],
+ "uri": "A String", # The base URI the user must click to trigger the authorization code login flow.
+ },
+ "description": "A String", # Description.
+ "displayName": "A String", # Display name of the parameter.
+ "enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM`
+ { # EnumOption definition
+ "displayName": "A String", # Display name of the option.
+ "id": "A String", # Id of the option.
+ },
+ ],
+ "isAdvanced": True or False, # Indicates if current template is part of advanced settings
+ "key": "A String", # Key of the config variable.
+ "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
+ "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
+ "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
+ "fieldComparisons": [ # A list of fields to be compared.
+ { # Field that needs to be compared.
+ "boolValue": True or False, # Boolean value
+ "comparator": "A String", # Comparator to use for comparing the field value.
+ "intValue": "A String", # Integer value
+ "key": "A String", # Key of the field.
+ "stringValue": "A String", # String value
+ },
+ ],
+ "logicalExpressions": [ # A list of nested conditions to be compared.
+ # Object with schema name: LogicalExpression
+ ],
+ "logicalOperator": "A String", # The logical operator to use between the fields and conditions.
+ },
+ "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Role grant configuration for the config variable.
+ "helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers.
+ "principal": "A String", # Prinicipal/Identity for whom the role need to assigned.
+ "resource": { # Resource definition # Resource on which the roles needs to be granted for the principal.
+ "pathTemplate": "A String", # Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template.
+ "type": "A String", # Different types of resource supported.
+ },
+ "roles": [ # List of roles that need to be granted.
+ "A String",
+ ],
},
- ],
- "key": "A String", # The key is the destination identifier that is supported by the Connector.
- },
- "enableBackendDestinationConfig": True or False, # Optional. Whether to enable backend destination config. This is the backend server that the connector connects to.
+ "state": "A String", # State of the config variable.
+ "validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
+ "valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.
+ },
+ ],
+ "createTime": "A String", # Output only. Created time.
+ "destinationConfigs": [ # Optional. Destination config(s) for accessing connector facade/ proxy. This is used only when enable_backend_destination_config is true.
+ { # Define the Connectors target endpoint.
+ "destinations": [ # The destinations for the key.
+ {
+ "host": "A String", # For publicly routable host.
+ "port": 42, # The port is the target port number that is accepted by the destination.
+ "serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
+ },
+ ],
+ "key": "A String", # The key is the destination identifier that is supported by the Connector.
+ },
+ ],
+ "enableBackendDestinationConfig": True or False, # Optional. When enabled, the connector will be a facade/ proxy, and connects to the destination provided during connection creation.
"labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
"a_key": "A String",
},
"name": "A String", # Output only. Identifier. Resource name of the Version. Format: projects/{project}/locations/{location}/customConnectors/{custom_connector}/customConnectorVersions/{custom_connector_version}
- "serviceAccount": "A String", # Required. Service account needed for runtime plane to access Custom Connector secrets.
+ "serviceAccount": "A String", # Required. Service account used by runtime plane to access auth config secrets.
"specLocation": "A String", # Optional. Location of the custom connector spec.
"updateTime": "A String", # Output only. Updated time.
}
@@ -383,7 +493,7 @@ Method Details
{ # Response message for Connectors.ListCustomConnectorVersions.
"customConnectorVersions": [ # A list of connector versions.
{ # CustomConnectorVersion indicates a specific version of a connector.
- "authConfig": { # AuthConfig defines details of a authentication type. # Required. Configuration for establishing the authentication to the connector destination.
+ "authConfig": { # AuthConfig defines details of a authentication type. # Optional. Authentication config for accessing connector facade/ proxy. This is used only when enable_backend_destination_config is true.
"additionalVariables": [ # List containing additional auth configs.
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
"boolValue": True or False, # Value is a bool.
@@ -448,23 +558,78 @@ Method Details
"username": "A String", # Username.
},
},
- "createTime": "A String", # Output only. Created time.
- "destinationConfig": { # Define the Connectors target endpoint. # Required. Configuration of the customConnector's destination.
- "destinations": [ # The destinations for the key.
- {
- "host": "A String", # For publicly routable host.
- "port": 42, # The port is the target port number that is accepted by the destination.
- "serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
+ "backendVariableTemplates": [ # Optional. Backend variables config templates. This translates to additional variable templates in connection.
+ { # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection.
+ "authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE`
+ "clientId": "A String", # The client ID assigned to the Google Cloud Connectors OAuth app for the connector data source.
+ "enablePkce": True or False, # Whether to enable PKCE for the auth code flow.
+ "scopes": [ # The scopes for which the user will authorize Google Cloud Connectors on the connector data source.
+ "A String",
+ ],
+ "uri": "A String", # The base URI the user must click to trigger the authorization code login flow.
},
- ],
- "key": "A String", # The key is the destination identifier that is supported by the Connector.
- },
- "enableBackendDestinationConfig": True or False, # Optional. Whether to enable backend destination config. This is the backend server that the connector connects to.
+ "description": "A String", # Description.
+ "displayName": "A String", # Display name of the parameter.
+ "enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM`
+ { # EnumOption definition
+ "displayName": "A String", # Display name of the option.
+ "id": "A String", # Id of the option.
+ },
+ ],
+ "isAdvanced": True or False, # Indicates if current template is part of advanced settings
+ "key": "A String", # Key of the config variable.
+ "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
+ "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
+ "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
+ "fieldComparisons": [ # A list of fields to be compared.
+ { # Field that needs to be compared.
+ "boolValue": True or False, # Boolean value
+ "comparator": "A String", # Comparator to use for comparing the field value.
+ "intValue": "A String", # Integer value
+ "key": "A String", # Key of the field.
+ "stringValue": "A String", # String value
+ },
+ ],
+ "logicalExpressions": [ # A list of nested conditions to be compared.
+ # Object with schema name: LogicalExpression
+ ],
+ "logicalOperator": "A String", # The logical operator to use between the fields and conditions.
+ },
+ "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Role grant configuration for the config variable.
+ "helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers.
+ "principal": "A String", # Prinicipal/Identity for whom the role need to assigned.
+ "resource": { # Resource definition # Resource on which the roles needs to be granted for the principal.
+ "pathTemplate": "A String", # Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template.
+ "type": "A String", # Different types of resource supported.
+ },
+ "roles": [ # List of roles that need to be granted.
+ "A String",
+ ],
+ },
+ "state": "A String", # State of the config variable.
+ "validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
+ "valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.
+ },
+ ],
+ "createTime": "A String", # Output only. Created time.
+ "destinationConfigs": [ # Optional. Destination config(s) for accessing connector facade/ proxy. This is used only when enable_backend_destination_config is true.
+ { # Define the Connectors target endpoint.
+ "destinations": [ # The destinations for the key.
+ {
+ "host": "A String", # For publicly routable host.
+ "port": 42, # The port is the target port number that is accepted by the destination.
+ "serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
+ },
+ ],
+ "key": "A String", # The key is the destination identifier that is supported by the Connector.
+ },
+ ],
+ "enableBackendDestinationConfig": True or False, # Optional. When enabled, the connector will be a facade/ proxy, and connects to the destination provided during connection creation.
"labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
"a_key": "A String",
},
"name": "A String", # Output only. Identifier. Resource name of the Version. Format: projects/{project}/locations/{location}/customConnectors/{custom_connector}/customConnectorVersions/{custom_connector_version}
- "serviceAccount": "A String", # Required. Service account needed for runtime plane to access Custom Connector secrets.
+ "serviceAccount": "A String", # Required. Service account used by runtime plane to access auth config secrets.
"specLocation": "A String", # Optional. Location of the custom connector spec.
"updateTime": "A String", # Output only. Updated time.
},
@@ -500,7 +665,7 @@ Method Details
The object takes the form of:
{ # CustomConnectorVersion indicates a specific version of a connector.
- "authConfig": { # AuthConfig defines details of a authentication type. # Required. Configuration for establishing the authentication to the connector destination.
+ "authConfig": { # AuthConfig defines details of a authentication type. # Optional. Authentication config for accessing connector facade/ proxy. This is used only when enable_backend_destination_config is true.
"additionalVariables": [ # List containing additional auth configs.
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
"boolValue": True or False, # Value is a bool.
@@ -565,23 +730,78 @@ Method Details
"username": "A String", # Username.
},
},
- "createTime": "A String", # Output only. Created time.
- "destinationConfig": { # Define the Connectors target endpoint. # Required. Configuration of the customConnector's destination.
- "destinations": [ # The destinations for the key.
- {
- "host": "A String", # For publicly routable host.
- "port": 42, # The port is the target port number that is accepted by the destination.
- "serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
+ "backendVariableTemplates": [ # Optional. Backend variables config templates. This translates to additional variable templates in connection.
+ { # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection.
+ "authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE`
+ "clientId": "A String", # The client ID assigned to the Google Cloud Connectors OAuth app for the connector data source.
+ "enablePkce": True or False, # Whether to enable PKCE for the auth code flow.
+ "scopes": [ # The scopes for which the user will authorize Google Cloud Connectors on the connector data source.
+ "A String",
+ ],
+ "uri": "A String", # The base URI the user must click to trigger the authorization code login flow.
+ },
+ "description": "A String", # Description.
+ "displayName": "A String", # Display name of the parameter.
+ "enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM`
+ { # EnumOption definition
+ "displayName": "A String", # Display name of the option.
+ "id": "A String", # Id of the option.
+ },
+ ],
+ "isAdvanced": True or False, # Indicates if current template is part of advanced settings
+ "key": "A String", # Key of the config variable.
+ "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
+ "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
+ "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
+ "fieldComparisons": [ # A list of fields to be compared.
+ { # Field that needs to be compared.
+ "boolValue": True or False, # Boolean value
+ "comparator": "A String", # Comparator to use for comparing the field value.
+ "intValue": "A String", # Integer value
+ "key": "A String", # Key of the field.
+ "stringValue": "A String", # String value
+ },
+ ],
+ "logicalExpressions": [ # A list of nested conditions to be compared.
+ # Object with schema name: LogicalExpression
+ ],
+ "logicalOperator": "A String", # The logical operator to use between the fields and conditions.
+ },
+ "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Role grant configuration for the config variable.
+ "helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers.
+ "principal": "A String", # Prinicipal/Identity for whom the role need to assigned.
+ "resource": { # Resource definition # Resource on which the roles needs to be granted for the principal.
+ "pathTemplate": "A String", # Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template.
+ "type": "A String", # Different types of resource supported.
+ },
+ "roles": [ # List of roles that need to be granted.
+ "A String",
+ ],
},
- ],
- "key": "A String", # The key is the destination identifier that is supported by the Connector.
- },
- "enableBackendDestinationConfig": True or False, # Optional. Whether to enable backend destination config. This is the backend server that the connector connects to.
+ "state": "A String", # State of the config variable.
+ "validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
+ "valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.
+ },
+ ],
+ "createTime": "A String", # Output only. Created time.
+ "destinationConfigs": [ # Optional. Destination config(s) for accessing connector facade/ proxy. This is used only when enable_backend_destination_config is true.
+ { # Define the Connectors target endpoint.
+ "destinations": [ # The destinations for the key.
+ {
+ "host": "A String", # For publicly routable host.
+ "port": 42, # The port is the target port number that is accepted by the destination.
+ "serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
+ },
+ ],
+ "key": "A String", # The key is the destination identifier that is supported by the Connector.
+ },
+ ],
+ "enableBackendDestinationConfig": True or False, # Optional. When enabled, the connector will be a facade/ proxy, and connects to the destination provided during connection creation.
"labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
"a_key": "A String",
},
"name": "A String", # Output only. Identifier. Resource name of the Version. Format: projects/{project}/locations/{location}/customConnectors/{custom_connector}/customConnectorVersions/{custom_connector_version}
- "serviceAccount": "A String", # Required. Service account needed for runtime plane to access Custom Connector secrets.
+ "serviceAccount": "A String", # Required. Service account used by runtime plane to access auth config secrets.
"specLocation": "A String", # Optional. Location of the custom connector spec.
"updateTime": "A String", # Output only. Updated time.
}
diff --git a/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html b/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html
index a9069eefd50..2dbfe8ff0e4 100644
--- a/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html
+++ b/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html
@@ -141,6 +141,7 @@ Method Details
],
"isAdvanced": True or False, # Indicates if current template is part of advanced settings
"key": "A String", # Key of the config variable.
+ "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # A list of fields to be compared.
@@ -197,6 +198,7 @@ Method Details
],
"isAdvanced": True or False, # Indicates if current template is part of advanced settings
"key": "A String", # Key of the config variable.
+ "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # A list of fields to be compared.
@@ -298,6 +300,7 @@ Method Details
],
"isAdvanced": True or False, # Indicates if current template is part of advanced settings
"key": "A String", # Key of the config variable.
+ "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # A list of fields to be compared.
@@ -354,6 +357,7 @@ Method Details
],
"isAdvanced": True or False, # Indicates if current template is part of advanced settings
"key": "A String", # Key of the config variable.
+ "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # A list of fields to be compared.
@@ -411,6 +415,7 @@ Method Details
],
"isAdvanced": True or False, # Indicates if current template is part of advanced settings
"key": "A String", # Key of the config variable.
+ "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # A list of fields to be compared.
@@ -469,6 +474,7 @@ Method Details
],
"isAdvanced": True or False, # Indicates if current template is part of advanced settings
"key": "A String", # Key of the config variable.
+ "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # A list of fields to be compared.
@@ -568,6 +574,7 @@ Method Details
],
"isAdvanced": True or False, # Indicates if current template is part of advanced settings
"key": "A String", # Key of the config variable.
+ "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # A list of fields to be compared.
@@ -614,6 +621,9 @@ Method Details
"entityApis": True or False, # Specifies if the connector supports entity apis like 'createEntity'.
"sqlQuery": True or False, # Specifies if the connector supports 'ExecuteSqlQuery' operation.
},
+ "unsupportedConnectionTypes": [ # Output only. Unsupported connection types.
+ "A String",
+ ],
"updateTime": "A String", # Output only. Updated time.
}
@@ -666,6 +676,7 @@ Method Details
],
"isAdvanced": True or False, # Indicates if current template is part of advanced settings
"key": "A String", # Key of the config variable.
+ "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # A list of fields to be compared.
@@ -722,6 +733,7 @@ Method Details
],
"isAdvanced": True or False, # Indicates if current template is part of advanced settings
"key": "A String", # Key of the config variable.
+ "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # A list of fields to be compared.
@@ -823,6 +835,7 @@ Method Details
],
"isAdvanced": True or False, # Indicates if current template is part of advanced settings
"key": "A String", # Key of the config variable.
+ "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # A list of fields to be compared.
@@ -879,6 +892,7 @@ Method Details
],
"isAdvanced": True or False, # Indicates if current template is part of advanced settings
"key": "A String", # Key of the config variable.
+ "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # A list of fields to be compared.
@@ -936,6 +950,7 @@ Method Details
],
"isAdvanced": True or False, # Indicates if current template is part of advanced settings
"key": "A String", # Key of the config variable.
+ "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # A list of fields to be compared.
@@ -994,6 +1009,7 @@ Method Details
],
"isAdvanced": True or False, # Indicates if current template is part of advanced settings
"key": "A String", # Key of the config variable.
+ "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # A list of fields to be compared.
@@ -1093,6 +1109,7 @@ Method Details
],
"isAdvanced": True or False, # Indicates if current template is part of advanced settings
"key": "A String", # Key of the config variable.
+ "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # A list of fields to be compared.
@@ -1139,6 +1156,9 @@ Method Details
"entityApis": True or False, # Specifies if the connector supports entity apis like 'createEntity'.
"sqlQuery": True or False, # Specifies if the connector supports 'ExecuteSqlQuery' operation.
},
+ "unsupportedConnectionTypes": [ # Output only. Unsupported connection types.
+ "A String",
+ ],
"updateTime": "A String", # Output only. Updated time.
},
],
diff --git a/docs/dyn/connectors_v2.projects.locations.connections.html b/docs/dyn/connectors_v2.projects.locations.connections.html
index 05f532260f4..108a7d7e08d 100644
--- a/docs/dyn/connectors_v2.projects.locations.connections.html
+++ b/docs/dyn/connectors_v2.projects.locations.connections.html
@@ -84,18 +84,98 @@ Instance Methods
Returns the entityTypes Resource.
+
+ checkReadiness(name, x__xgafv=None)
+Reports readiness status of the connector. Similar logic to GetStatus but modified for kubernetes health check to understand.
+
+ checkStatus(name, x__xgafv=None)
+Reports the status of the connection. Note that when the connection is in a state that is not ACTIVE, the implementation of this RPC method must return a Status with the corresponding State instead of returning a gRPC status code that is not "OK", which indicates that ConnectionStatus itself, not the connection, failed.
Close httplib2 connections.
+
+ exchangeAuthCode(name, body=None, x__xgafv=None)
+ExchangeAuthCode exchanges the OAuth authorization code (and other necessary data) for an access token (and associated credentials).
executeSqlQuery(connection, body=None, x__xgafv=None)
Executes a SQL statement specified in the body of the request. An example of this SQL statement in the case of Salesforce connector would be 'select * from Account a, Order o where a.Id = o.AccountId'.
+
+ refreshAccessToken(name, body=None, x__xgafv=None)
+RefreshAccessToken exchanges the OAuth refresh token (and other necessary data) for a new access token (and new associated credentials).
Method Details
+
+ checkReadiness(name, x__xgafv=None)
+ Reports readiness status of the connector. Similar logic to GetStatus but modified for kubernetes health check to understand.
+
+Args:
+ name: string, A parameter (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response containing status of the connector for readiness prober.
+ "status": "A String",
+}
+
+
+
+ checkStatus(name, x__xgafv=None)
+ Reports the status of the connection. Note that when the connection is in a state that is not ACTIVE, the implementation of this RPC method must return a Status with the corresponding State instead of returning a gRPC status code that is not "OK", which indicates that ConnectionStatus itself, not the connection, failed.
+
+Args:
+ name: string, A parameter (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The status of the connector.
+ "description": "A String", # When the connector is not in ACTIVE state, the description must be populated to specify the reason why it's not in ACTIVE state.
+ "state": "A String", # State of the connector.
+}
+
+
close()
Close httplib2 connections.
+
+ exchangeAuthCode(name, body=None, x__xgafv=None)
+ ExchangeAuthCode exchanges the OAuth authorization code (and other necessary data) for an access token (and associated credentials).
+
+Args:
+ name: string, A parameter (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # ExchangeAuthCodeRequest currently includes no fields.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # ExchangeAuthCodeResponse includes the returned access token and its associated credentials.
+ "accessCredentials": { # AccessCredentials includes the OAuth access token, and the other fields returned along with it.
+ "accessToken": "A String", # OAuth access token.
+ "expiresIn": "A String", # Duration till the access token expires.
+ "refreshToken": "A String", # OAuth refresh token.
+ },
+}
+
+
executeSqlQuery(connection, body=None, x__xgafv=None)
Executes a SQL statement specified in the body of the request. An example of this SQL statement in the case of Salesforce connector would be 'select * from Account a, Order o where a.Id = o.AccountId'.
@@ -136,4 +216,33 @@ Method Details
}
+
+ refreshAccessToken(name, body=None, x__xgafv=None)
+ RefreshAccessToken exchanges the OAuth refresh token (and other necessary data) for a new access token (and new associated credentials).
+
+Args:
+ name: string, A parameter (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # RefreshAccessTokenRequest currently includes no fields.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # RefreshAccessTokenResponse includes the returned access token and its associated credentials.
+ "accessCredentials": { # AccessCredentials includes the OAuth access token, and the other fields returned along with it.
+ "accessToken": "A String", # OAuth access token.
+ "expiresIn": "A String", # Duration till the access token expires.
+ "refreshToken": "A String", # OAuth refresh token.
+ },
+}
+
+