mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-06 19:45:20 +01:00
update all json files
This commit is contained in:
Sebastian Thiel
@@ -24,6 +24,7 @@
|
||||
},
|
||||
"id": "pubsub:v1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://pubsub.mtls.googleapis.com/",
|
||||
"name": "pubsub",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -120,7 +121,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Optional user-provided name for this snapshot.\nIf the name is not provided in the request, the server will assign a random\nname for this snapshot on the same project as the subscription.\nNote that for REST API requests, you must specify a name. See the\n<a href=\"https://cloud.google.com/pubsub/docs/admin#resource_names\">\nresource name rules</a>.\nFormat is `projects/{project}/snapshots/{snap}`.",
|
||||
"description": "Required. User-provided name for this snapshot. If the name is not provided in the\nrequest, the server will assign a random name for this snapshot on the same\nproject as the subscription. Note that for REST API requests, you must\nspecify a name. See the <a\nhref=\"https://cloud.google.com/pubsub/docs/admin#resource_names\"> resource\nname rules</a>. Format is `projects/{project}/snapshots/{snap}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/snapshots/[^/]+$",
|
||||
"required": true,
|
||||
@@ -149,7 +150,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"snapshot": {
|
||||
"description": "The name of the snapshot to delete.\nFormat is `projects/{project}/snapshots/{snap}`.",
|
||||
"description": "Required. The name of the snapshot to delete.\nFormat is `projects/{project}/snapshots/{snap}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/snapshots/[^/]+$",
|
||||
"required": true,
|
||||
@@ -175,7 +176,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"snapshot": {
|
||||
"description": "The name of the snapshot to get.\nFormat is `projects/{project}/snapshots/{snap}`.",
|
||||
"description": "Required. The name of the snapshot to get.\nFormat is `projects/{project}/snapshots/{snap}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/snapshots/[^/]+$",
|
||||
"required": true,
|
||||
@@ -200,6 +201,12 @@
|
||||
"resource"
|
||||
],
|
||||
"parameters": {
|
||||
"options.requestedPolicyVersion": {
|
||||
"description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"resource": {
|
||||
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
|
||||
"location": "path",
|
||||
@@ -238,7 +245,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"project": {
|
||||
"description": "The name of the project in which to list snapshots.\nFormat is `projects/{project-id}`.",
|
||||
"description": "Required. The name of the project in which to list snapshots.\nFormat is `projects/{project-id}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+$",
|
||||
"required": true,
|
||||
@@ -284,7 +291,7 @@
|
||||
]
|
||||
},
|
||||
"setIamPolicy": {
|
||||
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
|
||||
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED",
|
||||
"flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:setIamPolicy",
|
||||
"httpMethod": "POST",
|
||||
"id": "pubsub.projects.snapshots.setIamPolicy",
|
||||
@@ -355,7 +362,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"subscription": {
|
||||
"description": "The subscription whose message is being acknowledged.\nFormat is `projects/{project}/subscriptions/{sub}`.",
|
||||
"description": "Required. The subscription whose message is being acknowledged.\nFormat is `projects/{project}/subscriptions/{sub}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/subscriptions/[^/]+$",
|
||||
"required": true,
|
||||
@@ -384,7 +391,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.",
|
||||
"description": "Required. The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/subscriptions/[^/]+$",
|
||||
"required": true,
|
||||
@@ -413,7 +420,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"subscription": {
|
||||
"description": "The subscription to delete.\nFormat is `projects/{project}/subscriptions/{sub}`.",
|
||||
"description": "Required. The subscription to delete.\nFormat is `projects/{project}/subscriptions/{sub}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/subscriptions/[^/]+$",
|
||||
"required": true,
|
||||
@@ -439,7 +446,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"subscription": {
|
||||
"description": "The name of the subscription to get.\nFormat is `projects/{project}/subscriptions/{sub}`.",
|
||||
"description": "Required. The name of the subscription to get.\nFormat is `projects/{project}/subscriptions/{sub}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/subscriptions/[^/]+$",
|
||||
"required": true,
|
||||
@@ -464,6 +471,12 @@
|
||||
"resource"
|
||||
],
|
||||
"parameters": {
|
||||
"options.requestedPolicyVersion": {
|
||||
"description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"resource": {
|
||||
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
|
||||
"location": "path",
|
||||
@@ -502,7 +515,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"project": {
|
||||
"description": "The name of the project in which to list subscriptions.\nFormat is `projects/{project-id}`.",
|
||||
"description": "Required. The name of the project in which to list subscriptions.\nFormat is `projects/{project-id}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+$",
|
||||
"required": true,
|
||||
@@ -528,7 +541,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"subscription": {
|
||||
"description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.",
|
||||
"description": "Required. The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/subscriptions/[^/]+$",
|
||||
"required": true,
|
||||
@@ -557,7 +570,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"subscription": {
|
||||
"description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.",
|
||||
"description": "Required. The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/subscriptions/[^/]+$",
|
||||
"required": true,
|
||||
@@ -586,7 +599,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.",
|
||||
"description": "Required. The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/subscriptions/[^/]+$",
|
||||
"required": true,
|
||||
@@ -615,7 +628,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"subscription": {
|
||||
"description": "The subscription from which messages should be pulled.\nFormat is `projects/{project}/subscriptions/{sub}`.",
|
||||
"description": "Required. The subscription from which messages should be pulled.\nFormat is `projects/{project}/subscriptions/{sub}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/subscriptions/[^/]+$",
|
||||
"required": true,
|
||||
@@ -644,7 +657,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"subscription": {
|
||||
"description": "The subscription to affect.",
|
||||
"description": "Required. The subscription to affect.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/subscriptions/[^/]+$",
|
||||
"required": true,
|
||||
@@ -664,7 +677,7 @@
|
||||
]
|
||||
},
|
||||
"setIamPolicy": {
|
||||
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
|
||||
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED",
|
||||
"flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:setIamPolicy",
|
||||
"httpMethod": "POST",
|
||||
"id": "pubsub.projects.subscriptions.setIamPolicy",
|
||||
@@ -735,7 +748,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.",
|
||||
"description": "Required. The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/topics/[^/]+$",
|
||||
"required": true,
|
||||
@@ -764,7 +777,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"topic": {
|
||||
"description": "Name of the topic to delete.\nFormat is `projects/{project}/topics/{topic}`.",
|
||||
"description": "Required. Name of the topic to delete.\nFormat is `projects/{project}/topics/{topic}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/topics/[^/]+$",
|
||||
"required": true,
|
||||
@@ -790,7 +803,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"topic": {
|
||||
"description": "The name of the topic to get.\nFormat is `projects/{project}/topics/{topic}`.",
|
||||
"description": "Required. The name of the topic to get.\nFormat is `projects/{project}/topics/{topic}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/topics/[^/]+$",
|
||||
"required": true,
|
||||
@@ -815,6 +828,12 @@
|
||||
"resource"
|
||||
],
|
||||
"parameters": {
|
||||
"options.requestedPolicyVersion": {
|
||||
"description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"resource": {
|
||||
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
|
||||
"location": "path",
|
||||
@@ -853,7 +872,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"project": {
|
||||
"description": "The name of the project in which to list topics.\nFormat is `projects/{project-id}`.",
|
||||
"description": "Required. The name of the project in which to list topics.\nFormat is `projects/{project-id}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+$",
|
||||
"required": true,
|
||||
@@ -879,7 +898,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.",
|
||||
"description": "Required. The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/topics/[^/]+$",
|
||||
"required": true,
|
||||
@@ -908,7 +927,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"topic": {
|
||||
"description": "The messages in the request will be published on this topic.\nFormat is `projects/{project}/topics/{topic}`.",
|
||||
"description": "Required. The messages in the request will be published on this topic.\nFormat is `projects/{project}/topics/{topic}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/topics/[^/]+$",
|
||||
"required": true,
|
||||
@@ -928,7 +947,7 @@
|
||||
]
|
||||
},
|
||||
"setIamPolicy": {
|
||||
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
|
||||
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED",
|
||||
"flatPath": "v1/projects/{projectsId}/topics/{topicsId}:setIamPolicy",
|
||||
"httpMethod": "POST",
|
||||
"id": "pubsub.projects.topics.setIamPolicy",
|
||||
@@ -1010,7 +1029,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"topic": {
|
||||
"description": "The name of the topic that snapshots are attached to.\nFormat is `projects/{project}/topics/{topic}`.",
|
||||
"description": "Required. The name of the topic that snapshots are attached to.\nFormat is `projects/{project}/topics/{topic}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/topics/[^/]+$",
|
||||
"required": true,
|
||||
@@ -1051,7 +1070,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"topic": {
|
||||
"description": "The name of the topic that subscriptions are attached to.\nFormat is `projects/{project}/topics/{topic}`.",
|
||||
"description": "Required. The name of the topic that subscriptions are attached to.\nFormat is `projects/{project}/topics/{topic}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/topics/[^/]+$",
|
||||
"required": true,
|
||||
@@ -1074,7 +1093,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190625",
|
||||
"revision": "20200403",
|
||||
"rootUrl": "https://pubsub.googleapis.com/",
|
||||
"schemas": {
|
||||
"AcknowledgeRequest": {
|
||||
@@ -1082,7 +1101,7 @@
|
||||
"id": "AcknowledgeRequest",
|
||||
"properties": {
|
||||
"ackIds": {
|
||||
"description": "The acknowledgment ID for the messages being acknowledged that was returned\nby the Pub/Sub system in the `Pull` response. Must not be empty.",
|
||||
"description": "Required. The acknowledgment ID for the messages being acknowledged that was returned\nby the Pub/Sub system in the `Pull` response. Must not be empty.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1100,7 +1119,7 @@
|
||||
"description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently."
|
||||
},
|
||||
"members": {
|
||||
"description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
|
||||
"description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1125,12 +1144,28 @@
|
||||
"type": "object"
|
||||
},
|
||||
"subscription": {
|
||||
"description": "The subscription whose backlog the snapshot retains.\nSpecifically, the created snapshot is guaranteed to retain:\n (a) The existing backlog on the subscription. More precisely, this is\n defined as the messages in the subscription's backlog that are\n unacknowledged upon the successful completion of the\n `CreateSnapshot` request; as well as:\n (b) Any messages published to the subscription's topic following the\n successful completion of the CreateSnapshot request.\nFormat is `projects/{project}/subscriptions/{sub}`.",
|
||||
"description": "Required. The subscription whose backlog the snapshot retains.\nSpecifically, the created snapshot is guaranteed to retain:\n (a) The existing backlog on the subscription. More precisely, this is\n defined as the messages in the subscription's backlog that are\n unacknowledged upon the successful completion of the\n `CreateSnapshot` request; as well as:\n (b) Any messages published to the subscription's topic following the\n successful completion of the CreateSnapshot request.\nFormat is `projects/{project}/subscriptions/{sub}`.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"DeadLetterPolicy": {
|
||||
"description": "Dead lettering is done on a best effort basis. The same message might be\ndead lettered multiple times.\n\nIf validation on any of the fields fails at subscription creation/updation,\nthe create/update subscription request will fail.",
|
||||
"id": "DeadLetterPolicy",
|
||||
"properties": {
|
||||
"deadLetterTopic": {
|
||||
"description": "The name of the topic to which dead letter messages should be published.\nFormat is `projects/{project}/topics/{topic}`.The Cloud Pub/Sub service\naccount associated with the enclosing subscription's parent project (i.e.,\nservice-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have\npermission to Publish() to this topic.\n\nThe operation will fail if the topic does not exist.\nUsers should ensure that there is a subscription attached to this topic\nsince messages published to a topic with no subscriptions are lost.",
|
||||
"type": "string"
|
||||
},
|
||||
"maxDeliveryAttempts": {
|
||||
"description": "The maximum number of delivery attempts for any message. The value must be\nbetween 5 and 100.\n\nThe number of delivery attempts is defined as 1 + (the sum of number of\nNACKs and number of times the acknowledgement deadline has been exceeded\nfor the message).\n\nA NACK is any call to ModifyAckDeadline with a 0 deadline. Note that\nclient libraries may automatically extend ack_deadlines.\n\nThis field will be honored on a best effort basis.\n\nIf this parameter is 0, a default value of 5 is used.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Empty": {
|
||||
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
|
||||
"id": "Empty",
|
||||
@@ -1150,23 +1185,23 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Expr": {
|
||||
"description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) > 0\"",
|
||||
"description": "Represents a textual expression in the Common Expression Language (CEL)\nsyntax. CEL is a C-like expression language. The syntax and semantics of CEL\nare documented at https://github.com/google/cel-spec.\n\nExample (Comparison):\n\n title: \"Summary size limit\"\n description: \"Determines if a summary is less than 100 chars\"\n expression: \"document.summary.size() < 100\"\n\nExample (Equality):\n\n title: \"Requestor is owner\"\n description: \"Determines if requestor is the document owner\"\n expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\n title: \"Public documents\"\n description: \"Determine whether the document should be publicly visible\"\n expression: \"document.type != 'private' && document.type != 'internal'\"\n\nExample (Data Manipulation):\n\n title: \"Notification string\"\n description: \"Create a notification string with a timestamp.\"\n expression: \"'New message received at ' + string(document.create_time)\"\n\nThe exact variables and functions that may be referenced within an expression\nare determined by the service that evaluates it. See the service\ndocumentation for additional information.",
|
||||
"id": "Expr",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"description": "Optional. Description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"type": "string"
|
||||
},
|
||||
"expression": {
|
||||
"description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
|
||||
"description": "Textual representation of an expression in Common Expression Language\nsyntax.",
|
||||
"type": "string"
|
||||
},
|
||||
"location": {
|
||||
"description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"description": "Optional. String indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"description": "Optional. Title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -1280,12 +1315,12 @@
|
||||
"id": "ModifyAckDeadlineRequest",
|
||||
"properties": {
|
||||
"ackDeadlineSeconds": {
|
||||
"description": "The new ack deadline with respect to the time this request was sent to\nthe Pub/Sub system. For example, if the value is 10, the new\nack deadline will expire 10 seconds after the `ModifyAckDeadline` call\nwas made. Specifying zero might immediately make the message available for\ndelivery to another subscriber client. This typically results in an\nincrease in the rate of message redeliveries (that is, duplicates).\nThe minimum deadline you can specify is 0 seconds.\nThe maximum deadline you can specify is 600 seconds (10 minutes).",
|
||||
"description": "Required. The new ack deadline with respect to the time this request was sent to\nthe Pub/Sub system. For example, if the value is 10, the new\nack deadline will expire 10 seconds after the `ModifyAckDeadline` call\nwas made. Specifying zero might immediately make the message available for\ndelivery to another subscriber client. This typically results in an\nincrease in the rate of message redeliveries (that is, duplicates).\nThe minimum deadline you can specify is 0 seconds.\nThe maximum deadline you can specify is 600 seconds (10 minutes).",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"ackIds": {
|
||||
"description": "List of acknowledgment IDs.",
|
||||
"description": "Required. List of acknowledgment IDs.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1300,7 +1335,7 @@
|
||||
"properties": {
|
||||
"pushConfig": {
|
||||
"$ref": "PushConfig",
|
||||
"description": "The push configuration for future deliveries.\n\nAn empty `pushConfig` indicates that the Pub/Sub system should\nstop pushing messages from the given subscription and allow\nmessages to be pulled and acknowledged - effectively pausing\nthe subscription if `Pull` or `StreamingPull` is not called."
|
||||
"description": "Required. The push configuration for future deliveries.\n\nAn empty `pushConfig` indicates that the Pub/Sub system should\nstop pushing messages from the given subscription and allow\nmessages to be pulled and acknowledged - effectively pausing\nthe subscription if `Pull` or `StreamingPull` is not called."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -1321,23 +1356,23 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Policy": {
|
||||
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**JSON Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\n**YAML Example**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-other-app@appspot.gserviceaccount.com\n role: roles/owner\n - members:\n - user:sean@example.com\n role: roles/viewer\n\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
|
||||
"description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nOptionally, a `binding` can specify a `condition`, which is a logical\nexpression that allows access to a resource only if the expression evaluates\nto `true`. A condition can add constraints based on attributes of the\nrequest, the resource, or both.\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).",
|
||||
"id": "Policy",
|
||||
"properties": {
|
||||
"bindings": {
|
||||
"description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
|
||||
"description": "Associates a list of `members` to a `role`. Optionally, may specify a\n`condition` that determines how and when the `bindings` are applied. Each\nof the `bindings` must contain at least one member.",
|
||||
"items": {
|
||||
"$ref": "Binding"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"etag": {
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.",
|
||||
"format": "byte",
|
||||
"type": "string"
|
||||
},
|
||||
"version": {
|
||||
"description": "Deprecated.",
|
||||
"description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
@@ -1349,7 +1384,7 @@
|
||||
"id": "PublishRequest",
|
||||
"properties": {
|
||||
"messages": {
|
||||
"description": "The messages to publish.",
|
||||
"description": "Required. The messages to publish.",
|
||||
"items": {
|
||||
"$ref": "PubsubMessage"
|
||||
},
|
||||
@@ -1380,7 +1415,7 @@
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Optional attributes for this message.",
|
||||
"description": "Attributes for this message. If this field is empty, the message must\ncontain non-empty data.",
|
||||
"type": "object"
|
||||
},
|
||||
"data": {
|
||||
@@ -1405,12 +1440,12 @@
|
||||
"id": "PullRequest",
|
||||
"properties": {
|
||||
"maxMessages": {
|
||||
"description": "The maximum number of messages returned for this request. The Pub/Sub\nsystem may return fewer than the number specified.",
|
||||
"description": "Required. The maximum number of messages to return for this request. Must be a\npositive integer. The Pub/Sub system may return fewer than the number\nspecified.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"returnImmediately": {
|
||||
"description": "If this field set to true, the system will respond immediately even if\nit there are no messages available to return in the `Pull` response.\nOtherwise, the system may wait (for a bounded amount of time) until at\nleast one message is available, rather than returning no messages.",
|
||||
"description": "Optional. If this field set to true, the system will respond immediately even if\nit there are no messages available to return in the `Pull` response.\nOtherwise, the system may wait (for a bounded amount of time) until at\nleast one message is available, rather than returning no messages. Warning:\nsetting this field to `true` is discouraged because it adversely impacts\nthe performance of `Pull` operations. We recommend that users do not set\nthis field.",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
@@ -1438,7 +1473,7 @@
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Endpoint configuration attributes.\n\nEvery endpoint has a set of API supported attributes that can be used to\ncontrol different aspects of the message delivery.\n\nThe currently supported attribute is `x-goog-version`, which you can\nuse to change the format of the pushed message. This attribute\nindicates the version of the data expected by the endpoint. This\ncontrols the shape of the pushed message (i.e., its fields and metadata).\nThe endpoint version is based on the version of the Pub/Sub API.\n\nIf not present during the `CreateSubscription` call, it will default to\nthe version of the API used to make such call. If not present during a\n`ModifyPushConfig` call, its value will not be changed. `GetSubscription`\ncalls will always return a valid version, even if the subscription was\ncreated without this attribute.\n\nThe possible values for this attribute are:\n\n* `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.\n* `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.",
|
||||
"description": "Endpoint configuration attributes that can be used to control different\naspects of the message delivery.\n\nThe only currently supported attribute is `x-goog-version`, which you can\nuse to change the format of the pushed message. This attribute\nindicates the version of the data expected by the endpoint. This\ncontrols the shape of the pushed message (i.e., its fields and metadata).\n\nIf not present during the `CreateSubscription` call, it will default to\nthe version of the Pub/Sub API used to make such call. If not present in a\n`ModifyPushConfig` call, its value will not be changed. `GetSubscription`\ncalls will always return a valid version, even if the subscription was\ncreated without this attribute.\n\nThe only supported values for the `x-goog-version` attribute are:\n\n* `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.\n* `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.\n\nFor example:\n<pre><code>attributes { \"x-goog-version\": \"v1\" } </code></pre>",
|
||||
"type": "object"
|
||||
},
|
||||
"oidcToken": {
|
||||
@@ -1460,6 +1495,11 @@
|
||||
"description": "This ID can be used to acknowledge the received message.",
|
||||
"type": "string"
|
||||
},
|
||||
"deliveryAttempt": {
|
||||
"description": "Delivery attempt counter is 1 + (the sum of number of NACKs and number of\nack_deadline exceeds) for this message.\n\nA NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline\nexceeds event is whenever a message is not acknowledged within\nack_deadline. Note that ack_deadline is initially\nSubscription.ackDeadlineSeconds, but may get extended automatically by\nthe client library.\n\nThe first delivery of a given message will have this value as 1. The value\nis calculated at best effort and is approximate.\n\nIf a DeadLetterPolicy is not set on the subscription, this will be 0.\n<b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This\nAPI might be changed in backward-incompatible ways and is not recommended\nfor production use. It is not subject to any SLA or deprecation policy.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"message": {
|
||||
"$ref": "PubsubMessage",
|
||||
"description": "The message."
|
||||
@@ -1536,6 +1576,10 @@
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"deadLetterPolicy": {
|
||||
"$ref": "DeadLetterPolicy",
|
||||
"description": "A policy that specifies the conditions for dead lettering messages in\nthis subscription. If dead_letter_policy is not set, dead lettering\nis disabled.\n\nThe Cloud Pub/Sub service account associated with this subscriptions's\nparent project (i.e.,\nservice-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have\npermission to Acknowledge() messages on this subscription.\n<b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This\nAPI might be changed in backward-incompatible ways and is not recommended\nfor production use. It is not subject to any SLA or deprecation policy."
|
||||
},
|
||||
"expirationPolicy": {
|
||||
"$ref": "ExpirationPolicy",
|
||||
"description": "A policy that specifies the conditions for this subscription's expiration.\nA subscription is considered active as long as any connected subscriber is\nsuccessfully consuming messages from the subscription or is issuing\noperations on the subscription. If `expiration_policy` is not set, a\n*default policy* with `ttl` of 31 days will be used. The minimum allowed\nvalue for `expiration_policy.ttl` is 1 day."
|
||||
@@ -1553,7 +1597,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.",
|
||||
"description": "Required. The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.",
|
||||
"type": "string"
|
||||
},
|
||||
"pushConfig": {
|
||||
@@ -1565,7 +1609,7 @@
|
||||
"type": "boolean"
|
||||
},
|
||||
"topic": {
|
||||
"description": "The name of the topic from which this subscription is receiving messages.\nFormat is `projects/{project}/topics/{topic}`.\nThe value of this field will be `_deleted-topic_` if the topic has been\ndeleted.",
|
||||
"description": "Required. The name of the topic from which this subscription is receiving messages.\nFormat is `projects/{project}/topics/{topic}`.\nThe value of this field will be `_deleted-topic_` if the topic has been\ndeleted.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -1619,7 +1663,7 @@
|
||||
"description": "Policy constraining the set of Google Cloud Platform regions where messages\npublished to the topic may be stored. If not present, then no constraints\nare in effect."
|
||||
},
|
||||
"name": {
|
||||
"description": "The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.",
|
||||
"description": "Required. The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -1631,10 +1675,10 @@
|
||||
"properties": {
|
||||
"snapshot": {
|
||||
"$ref": "Snapshot",
|
||||
"description": "The updated snapshot object."
|
||||
"description": "Required. The updated snapshot object."
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "Indicates which fields in the provided snapshot to update.\nMust be specified and non-empty.",
|
||||
"description": "Required. Indicates which fields in the provided snapshot to update.\nMust be specified and non-empty.",
|
||||
"format": "google-fieldmask",
|
||||
"type": "string"
|
||||
}
|
||||
@@ -1647,10 +1691,10 @@
|
||||
"properties": {
|
||||
"subscription": {
|
||||
"$ref": "Subscription",
|
||||
"description": "The updated subscription object."
|
||||
"description": "Required. The updated subscription object."
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "Indicates which fields in the provided subscription to update.\nMust be specified and non-empty.",
|
||||
"description": "Required. Indicates which fields in the provided subscription to update.\nMust be specified and non-empty.",
|
||||
"format": "google-fieldmask",
|
||||
"type": "string"
|
||||
}
|
||||
@@ -1663,10 +1707,10 @@
|
||||
"properties": {
|
||||
"topic": {
|
||||
"$ref": "Topic",
|
||||
"description": "The updated topic object."
|
||||
"description": "Required. The updated topic object."
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "Indicates which fields in the provided topic to update. Must be specified\nand non-empty. Note that if `update_mask` contains\n\"message_storage_policy\" then the new value will be determined based on the\npolicy configured at the project or organization level. The\n`message_storage_policy` must not be set in the `topic` provided above.",
|
||||
"description": "Required. Indicates which fields in the provided topic to update. Must be specified\nand non-empty. Note that if `update_mask` contains\n\"message_storage_policy\" but the `message_storage_policy` is not set in\nthe `topic` provided above, then the updated value is determined by the\npolicy configured at the project or organization level.",
|
||||
"format": "google-fieldmask",
|
||||
"type": "string"
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user